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 - 2018, 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/ExtendedFirmwarePerformance.h>
26 #include <Guid/EndOfS3Resume.h>
27 #include <Guid/S3SmmInitDone.h>
28 #include <Ppi/S3Resume2.h>
29 #include <Ppi/SmmAccess.h>
30 #include <Ppi/PostBootScriptTable.h>
31 #include <Ppi/EndOfPeiPhase.h>
32 #include <Ppi/SmmCommunication.h>
34 #include <Library/DebugLib.h>
35 #include <Library/BaseLib.h>
36 #include <Library/PeimEntryPoint.h>
37 #include <Library/PeiServicesLib.h>
38 #include <Library/HobLib.h>
39 #include <Library/PerformanceLib.h>
40 #include <Library/PeiServicesTablePointerLib.h>
41 #include <Library/IoLib.h>
42 #include <Library/BaseMemoryLib.h>
43 #include <Library/MemoryAllocationLib.h>
44 #include <Library/PcdLib.h>
45 #include <Library/DebugAgentLib.h>
46 #include <Library/LocalApicLib.h>
47 #include <Library/ReportStatusCodeLib.h>
49 #include <Library/HobLib.h>
50 #include <Library/LockBoxLib.h>
51 #include <IndustryStandard/Acpi.h>
54 This macro aligns the address of a variable with auto storage
55 duration down to CPU_STACK_ALIGNMENT.
57 Since the stack grows downward, the result preserves more of the
58 stack than the original address (or the same amount), not less.
60 #define STACK_ALIGN_DOWN(Ptr) \
61 ((UINTN)(Ptr) & ~(UINTN)(CPU_STACK_ALIGNMENT - 1))
63 #define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull
78 UINT32 DefaultSize
: 1;
79 UINT32 Granularity
: 1;
86 // Page-Map Level-4 Offset (PML4) and
87 // Page-Directory-Pointer Offset (PDPE) entries 4K & 2MB
91 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
92 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
93 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
94 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
95 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
96 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
97 UINT64 Reserved
:1; // Reserved
98 UINT64 MustBeZero
:2; // Must Be Zero
99 UINT64 Available
:3; // Available for use by system software
100 UINT64 PageTableBaseAddress
:40; // Page Table Base Address
101 UINT64 AvabilableHigh
:11; // Available for use by system software
102 UINT64 Nx
:1; // No Execute bit
105 } PAGE_MAP_AND_DIRECTORY_POINTER
;
108 // Page Table Entry 2MB
112 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
113 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
114 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
115 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
116 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
117 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
118 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
119 UINT64 MustBe1
:1; // Must be 1
120 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
121 UINT64 Available
:3; // Available for use by system software
123 UINT64 MustBeZero
:8; // Must be zero;
124 UINT64 PageTableBaseAddress
:31; // Page Table Base Address
125 UINT64 AvabilableHigh
:11; // Available for use by system software
126 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
132 // Page Table Entry 1GB
136 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
137 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
138 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
139 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
140 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
141 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
142 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
143 UINT64 MustBe1
:1; // Must be 1
144 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
145 UINT64 Available
:3; // Available for use by system software
147 UINT64 MustBeZero
:17; // Must be zero;
148 UINT64 PageTableBaseAddress
:22; // Page Table Base Address
149 UINT64 AvabilableHigh
:11; // Available for use by system software
150 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
153 } PAGE_TABLE_1G_ENTRY
;
156 // Define two type of smm communicate headers.
157 // One for 32 bits PEI + 64 bits DXE, the other for 32 bits PEI + 32 bits DXE case.
161 UINT32 MessageLength
;
163 } SMM_COMMUNICATE_HEADER_32
;
167 UINT64 MessageLength
;
169 } SMM_COMMUNICATE_HEADER_64
;
174 // Function prototypes
177 a ASM function to transfer control to OS.
179 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table
180 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
184 (EFIAPI
*ASM_TRANSFER_CONTROL
) (
185 IN UINT32 S3WakingVector
,
186 IN UINT32 AcpiLowMemoryBase
190 Restores the platform to its preboot configuration for an S3 resume and
191 jumps to the OS waking vector.
193 This function will restore the platform to its pre-boot configuration that was
194 pre-stored in the boot script table and transfer control to OS waking vector.
195 Upon invocation, this function is responsible for locating the following
196 information before jumping to OS waking vector:
199 - any other information that it needs
201 The S3RestoreConfig() function then executes the pre-stored boot script table
202 and transitions the platform to the pre-boot state. The boot script is recorded
203 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
204 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
205 transfers control to the OS waking vector. If the OS supports only a real-mode
206 waking vector, this function will switch from flat mode to real mode before
207 jumping to the waking vector. If all platform pre-boot configurations are
208 successfully restored and all other necessary information is ready, this
209 function will never return and instead will directly jump to the OS waking
210 vector. If this function returns, it indicates that the attempt to resume
211 from the ACPI S3 sleep state failed.
213 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
215 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
216 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
217 resume boot path could not be located.
223 IN EFI_PEI_S3_RESUME2_PPI
*This
227 Set data segment selectors value including DS/ES/FS/GS/SS.
229 @param[in] SelectorValue Segment selector value to be set.
234 AsmSetDataSelectors (
235 IN UINT16 SelectorValue
241 EFI_PEI_S3_RESUME2_PPI mS3ResumePpi
= { S3RestoreConfig2
};
243 EFI_PEI_PPI_DESCRIPTOR mPpiList
= {
244 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
245 &gEfiPeiS3Resume2PpiGuid
,
249 EFI_PEI_PPI_DESCRIPTOR mPpiListPostScriptTable
= {
250 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
251 &gPeiPostScriptTablePpiGuid
,
255 EFI_PEI_PPI_DESCRIPTOR mPpiListEndOfPeiTable
= {
256 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
257 &gEfiEndOfPeiSignalPpiGuid
,
261 EFI_PEI_PPI_DESCRIPTOR mPpiListS3SmmInitDoneTable
= {
262 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
263 &gEdkiiS3SmmInitDoneGuid
,
268 // Global Descriptor Table (GDT)
270 GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT mGdtEntries
[] = {
271 /* selector { Global Segment Descriptor } */
272 /* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
273 /* 0x08 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
274 /* 0x10 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
275 /* 0x18 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
276 /* 0x20 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
277 /* 0x28 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
278 /* 0x30 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
279 /* 0x38 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 1, 0, 1, 0}},
280 /* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
283 #define DATA_SEGEMENT_SELECTOR 0x18
288 GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt
= {
289 sizeof (mGdtEntries
) - 1,
295 The function will check if current waking vector is long mode.
297 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
299 @retval TRUE Current context need long mode waking vector.
300 @retval FALSE Current context need not long mode waking vector.
303 IsLongModeWakingVector (
304 IN ACPI_S3_CONTEXT
*AcpiS3Context
307 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
309 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
310 if ((Facs
== NULL
) ||
311 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
312 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
313 // Something wrong with FACS
316 if (Facs
->XFirmwareWakingVector
!= 0) {
317 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
318 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
319 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
320 // Both BIOS and OS wants 64bit vector
321 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
330 Signal to SMM through communication buffer way.
332 @param[in] HandlerType SMI handler type to be signaled.
336 SignalToSmmByCommunication (
337 IN EFI_GUID
*HandlerType
341 EFI_PEI_SMM_COMMUNICATION_PPI
*SmmCommunicationPpi
;
343 SMM_COMMUNICATE_HEADER_32 Header32
;
344 SMM_COMMUNICATE_HEADER_64 Header64
;
347 DEBUG ((DEBUG_INFO
, "Signal %g to SMM - Enter\n", HandlerType
));
350 // This buffer consumed in DXE phase, so base on DXE mode to prepare communicate buffer.
351 // Detect whether DXE is 64 bits mode.
352 // if (sizeof(UINTN) == sizeof(UINT64), PEI already 64 bits, assume DXE also 64 bits.
353 // or (FeaturePcdGet (PcdDxeIplSwitchToLongMode)), DXE will switch to 64 bits.
355 if ((sizeof(UINTN
) == sizeof(UINT64
)) || (FeaturePcdGet (PcdDxeIplSwitchToLongMode
))) {
356 CommBuffer
= &Header64
;
357 Header64
.MessageLength
= 0;
358 CommSize
= OFFSET_OF (SMM_COMMUNICATE_HEADER_64
, Data
);
360 CommBuffer
= &Header32
;
361 Header32
.MessageLength
= 0;
362 CommSize
= OFFSET_OF (SMM_COMMUNICATE_HEADER_32
, Data
);
364 CopyGuid (CommBuffer
, HandlerType
);
366 Status
= PeiServicesLocatePpi (
367 &gEfiPeiSmmCommunicationPpiGuid
,
370 (VOID
**)&SmmCommunicationPpi
372 if (EFI_ERROR (Status
)) {
373 DEBUG ((DEBUG_ERROR
, "Locate Smm Communicate Ppi failed (%r)!\n", Status
));
377 Status
= SmmCommunicationPpi
->Communicate (
382 if (EFI_ERROR (Status
)) {
383 DEBUG ((DEBUG_ERROR
, "SmmCommunicationPpi->Communicate return failure (%r)!\n", Status
));
386 DEBUG ((DEBUG_INFO
, "Signal %g to SMM - Exit (%r)\n", HandlerType
, Status
));
391 Jump to OS waking vector.
392 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.
394 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
395 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
400 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
401 IN PEI_S3_RESUME_STATE
*PeiS3ResumeState
405 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
406 ASM_TRANSFER_CONTROL AsmTransferControl
;
408 UINTN TempStack
[0x10];
413 AsmWriteIdtr (&PeiS3ResumeState
->Idtr
);
415 if (PeiS3ResumeState
->ReturnStatus
!= EFI_SUCCESS
) {
417 // Report Status code that boot script execution is failed
420 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
421 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_BOOT_SCRIPT_ERROR
)
426 // NOTE: Because Debug Timer interrupt and system interrupts will be disabled
427 // in BootScriptExecuteDxe, the rest code in S3ResumeBootOs() cannot be halted
431 PERF_INMODULE_END ("ScriptExec");
434 // Install BootScriptDonePpi
436 PERF_INMODULE_BEGIN ("BootScriptDonePpi");
438 Status
= PeiServicesInstallPpi (&mPpiListPostScriptTable
);
439 ASSERT_EFI_ERROR (Status
);
441 PERF_INMODULE_END ("BootScriptDonePpi");
444 // Get ACPI Table Address
446 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
448 if ((Facs
== NULL
) ||
449 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
450 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
452 // Report Status code that no valid vector is found
455 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
456 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
463 // Install EndOfPeiPpi
465 PERF_INMODULE_BEGIN("EndOfPeiPpi");
467 Status
= PeiServicesInstallPpi (&mPpiListEndOfPeiTable
);
468 ASSERT_EFI_ERROR (Status
);
470 PERF_INMODULE_END("EndOfPeiPpi");
472 PERF_INMODULE_BEGIN("EndOfS3Resume");
474 DEBUG ((DEBUG_INFO
, "Signal EndOfS3Resume\n"));
476 // Signal EndOfS3Resume to SMM.
478 SignalToSmmByCommunication (&gEdkiiEndOfS3ResumeGuid
);
480 PERF_INMODULE_END ("EndOfS3Resume");
483 // report status code on S3 resume
485 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_OS_WAKE
);
487 AsmTransferControl
= (ASM_TRANSFER_CONTROL
)(UINTN
)PeiS3ResumeState
->AsmTransferControl
;
488 if (Facs
->XFirmwareWakingVector
!= 0) {
490 // Switch to native waking vector
492 TempStackTop
= (UINTN
)&TempStack
+ sizeof(TempStack
);
495 "%a() Stack Base: 0x%x, Stack Size: 0x%x\n",
500 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
501 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
502 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
504 // X64 long mode waking vector
506 DEBUG ((DEBUG_INFO
, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
507 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
510 Facs
->XFirmwareWakingVector
,
513 (UINT64
)(UINTN
)TempStackTop
517 // Report Status code that no valid waking vector is found
520 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
521 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
523 DEBUG (( EFI_D_ERROR
, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
530 // IA32 protected mode waking vector (Page disabled)
532 DEBUG ((DEBUG_INFO
, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
534 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) Facs
->XFirmwareWakingVector
,
537 (VOID
*)(UINTN
)TempStackTop
542 // 16bit Realmode waking vector
544 DEBUG ((DEBUG_INFO
, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN
)Facs
->FirmwareWakingVector
));
545 AsmTransferControl (Facs
->FirmwareWakingVector
, 0x0);
549 // Report Status code the failure of S3Resume
552 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
553 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
563 Restore S3 page table because we do not trust ACPINvs content.
564 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing.
566 @param S3NvsPageTableAddress PageTableAddress in ACPINvs
567 @param Build4GPageTableOnly If BIOS just build 4G page table only
570 RestoreS3PageTables (
571 IN UINTN S3NvsPageTableAddress
,
572 IN BOOLEAN Build4GPageTableOnly
575 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
578 UINT8 PhysicalAddressBits
;
579 EFI_PHYSICAL_ADDRESS PageAddress
;
580 UINTN IndexOfPml4Entries
;
581 UINTN IndexOfPdpEntries
;
582 UINTN IndexOfPageDirectoryEntries
;
583 UINT32 NumberOfPml4EntriesNeeded
;
584 UINT32 NumberOfPdpEntriesNeeded
;
585 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMapLevel4Entry
;
586 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMap
;
587 PAGE_MAP_AND_DIRECTORY_POINTER
*PageDirectoryPointerEntry
;
588 PAGE_TABLE_ENTRY
*PageDirectoryEntry
;
590 BOOLEAN Page1GSupport
;
591 PAGE_TABLE_1G_ENTRY
*PageDirectory1GEntry
;
592 UINT64 AddressEncMask
;
595 // Make sure AddressEncMask is contained to smallest supported address field
597 AddressEncMask
= PcdGet64 (PcdPteMemoryEncryptionAddressOrMask
) & PAGING_1G_ADDRESS_MASK_64
;
600 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.
601 // The whole page table is too large to be saved in SMRAM.
603 // The assumption is : whole page table is allocated in CONTINUOUS memory and CR3 points to TOP page.
605 DEBUG ((DEBUG_INFO
, "S3NvsPageTableAddress - %x (%x)\n", (UINTN
)S3NvsPageTableAddress
, (UINTN
)Build4GPageTableOnly
));
608 // By architecture only one PageMapLevel4 exists - so lets allocate storage for it.
610 PageMap
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
611 S3NvsPageTableAddress
+= SIZE_4KB
;
613 Page1GSupport
= FALSE
;
614 if (PcdGetBool(PcdUse1GPageTable
)) {
615 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
616 if (RegEax
>= 0x80000001) {
617 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
618 if ((RegEdx
& BIT26
) != 0) {
619 Page1GSupport
= TRUE
;
625 // Get physical address bits supported.
627 Hob
= GetFirstHob (EFI_HOB_TYPE_CPU
);
629 PhysicalAddressBits
= ((EFI_HOB_CPU
*) Hob
)->SizeOfMemorySpace
;
631 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
632 if (RegEax
>= 0x80000008) {
633 AsmCpuid (0x80000008, &RegEax
, NULL
, NULL
, NULL
);
634 PhysicalAddressBits
= (UINT8
) RegEax
;
636 PhysicalAddressBits
= 36;
641 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
643 ASSERT (PhysicalAddressBits
<= 52);
644 if (PhysicalAddressBits
> 48) {
645 PhysicalAddressBits
= 48;
649 // NOTE: In order to save time to create full page table, we just create 4G page table by default.
650 // And let PF handler in BootScript driver to create more on request.
652 if (Build4GPageTableOnly
) {
653 PhysicalAddressBits
= 32;
654 ZeroMem (PageMap
, EFI_PAGES_TO_SIZE(2));
657 // Calculate the table entries needed.
659 if (PhysicalAddressBits
<= 39) {
660 NumberOfPml4EntriesNeeded
= 1;
661 NumberOfPdpEntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 30));
663 NumberOfPml4EntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 39));
664 NumberOfPdpEntriesNeeded
= 512;
667 PageMapLevel4Entry
= PageMap
;
669 for (IndexOfPml4Entries
= 0; IndexOfPml4Entries
< NumberOfPml4EntriesNeeded
; IndexOfPml4Entries
++, PageMapLevel4Entry
++) {
671 // Each PML4 entry points to a page of Page Directory Pointer entires.
672 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.
674 PageDirectoryPointerEntry
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
675 S3NvsPageTableAddress
+= SIZE_4KB
;
680 PageMapLevel4Entry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryPointerEntry
| AddressEncMask
;
681 PageMapLevel4Entry
->Bits
.ReadWrite
= 1;
682 PageMapLevel4Entry
->Bits
.Present
= 1;
685 PageDirectory1GEntry
= (VOID
*) PageDirectoryPointerEntry
;
687 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectory1GEntry
++, PageAddress
+= SIZE_1GB
) {
689 // Fill in the Page Directory entries
691 PageDirectory1GEntry
->Uint64
= (UINT64
)PageAddress
| AddressEncMask
;
692 PageDirectory1GEntry
->Bits
.ReadWrite
= 1;
693 PageDirectory1GEntry
->Bits
.Present
= 1;
694 PageDirectory1GEntry
->Bits
.MustBe1
= 1;
697 for (IndexOfPdpEntries
= 0; IndexOfPdpEntries
< NumberOfPdpEntriesNeeded
; IndexOfPdpEntries
++, PageDirectoryPointerEntry
++) {
699 // Each Directory Pointer entries points to a page of Page Directory entires.
700 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.
702 PageDirectoryEntry
= (PAGE_TABLE_ENTRY
*)S3NvsPageTableAddress
;
703 S3NvsPageTableAddress
+= SIZE_4KB
;
706 // Fill in a Page Directory Pointer Entries
708 PageDirectoryPointerEntry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryEntry
| AddressEncMask
;
709 PageDirectoryPointerEntry
->Bits
.ReadWrite
= 1;
710 PageDirectoryPointerEntry
->Bits
.Present
= 1;
712 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectoryEntry
++, PageAddress
+= SIZE_2MB
) {
714 // Fill in the Page Directory entries
716 PageDirectoryEntry
->Uint64
= (UINT64
)PageAddress
| AddressEncMask
;
717 PageDirectoryEntry
->Bits
.ReadWrite
= 1;
718 PageDirectoryEntry
->Bits
.Present
= 1;
719 PageDirectoryEntry
->Bits
.MustBe1
= 1;
727 // If DXE is running 32-bit mode, no need to establish page table.
734 Jump to boot script executor driver.
736 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.
738 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
739 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in
740 boot script execute driver
744 S3ResumeExecuteBootScript (
745 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
746 IN BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
750 PEI_SMM_ACCESS_PPI
*SmmAccess
;
753 IA32_DESCRIPTOR
*IdtDescriptor
;
755 PEI_S3_RESUME_STATE
*PeiS3ResumeState
;
756 BOOLEAN InterruptStatus
;
758 DEBUG ((DEBUG_INFO
, "S3ResumeExecuteBootScript()\n"));
761 // Attempt to use content from SMRAM first
763 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
764 if (GuidHob
!= NULL
) {
766 // Last step for SMM - send SMI for initialization
772 SendSmiIpiAllExcludingSelf ();
776 SendSmiIpi (GetApicId ());
778 Status
= PeiServicesLocatePpi (
779 &gPeiSmmAccessPpiGuid
,
784 if (!EFI_ERROR (Status
)) {
785 DEBUG ((DEBUG_INFO
, "Close all SMRAM regions before executing boot script\n"));
787 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
788 Status
= SmmAccess
->Close ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
791 DEBUG ((DEBUG_INFO
, "Lock all SMRAM regions before executing boot script\n"));
793 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
794 Status
= SmmAccess
->Lock ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
798 DEBUG ((DEBUG_INFO
, "Signal S3SmmInitDone\n"));
800 // Install S3SmmInitDone PPI.
802 Status
= PeiServicesInstallPpi (&mPpiListS3SmmInitDoneTable
);
803 ASSERT_EFI_ERROR (Status
);
805 // Signal S3SmmInitDone to SMM.
807 SignalToSmmByCommunication (&gEdkiiS3SmmInitDoneGuid
);
810 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
811 AsmWriteCr3 ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
);
814 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport
)) {
816 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices
817 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)).
819 IdtDescriptor
= (IA32_DESCRIPTOR
*) (UINTN
) (AcpiS3Context
->IdtrProfile
);
821 // Make sure the newly allocated IDT align with 16-bytes
823 IdtBuffer
= AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor
->Limit
+ 1) + 16));
824 if (IdtBuffer
== NULL
) {
826 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
827 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_RESUME_FAILED
)
832 // Additional 16 bytes allocated to save IA32 IDT descriptor and Pei Service Table Pointer
833 // IA32 IDT descriptor will be used to setup IA32 IDT table for 32-bit Framework Boot Script code
835 ZeroMem (IdtBuffer
, 16);
836 AsmReadIdtr ((IA32_DESCRIPTOR
*)IdtBuffer
);
837 CopyMem ((VOID
*)((UINT8
*)IdtBuffer
+ 16),(VOID
*)(IdtDescriptor
->Base
), (IdtDescriptor
->Limit
+ 1));
838 IdtDescriptor
->Base
= (UINTN
)((UINT8
*)IdtBuffer
+ 16);
839 *(UINTN
*)(IdtDescriptor
->Base
- sizeof(UINTN
)) = (UINTN
)GetPeiServicesTablePointer ();
842 InterruptStatus
= SaveAndDisableInterrupts ();
844 // Need to make sure the GDT is loaded with values that support long mode and real mode.
846 AsmWriteGdtr (&mGdt
);
848 // update segment selectors per the new GDT.
850 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
852 // Restore interrupt state.
854 SetInterruptState (InterruptStatus
);
857 // Prepare data for return back
859 PeiS3ResumeState
= AllocatePool (sizeof(*PeiS3ResumeState
));
860 if (PeiS3ResumeState
== NULL
) {
862 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
863 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_RESUME_FAILED
)
867 DEBUG ((DEBUG_INFO
, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState
));
868 PeiS3ResumeState
->ReturnCs
= 0x10;
869 PeiS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeBootOs
;
870 PeiS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
874 AsmReadIdtr (&PeiS3ResumeState
->Idtr
);
877 // Report Status Code to indicate S3 boot script execution
879 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_S3_BOOT_SCRIPT
);
881 PERF_INMODULE_BEGIN ("ScriptExec");
883 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
887 DEBUG ((DEBUG_INFO
, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));
890 // Switch to long mode to complete resume.
894 EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
895 (UINT64
)(UINTN
)AcpiS3Context
,
896 (UINT64
)(UINTN
)PeiS3ResumeState
,
897 (UINT64
)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
903 DEBUG ((DEBUG_INFO
, "transfer control to Standalone Boot Script Executor\r\n"));
905 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
906 (VOID
*)AcpiS3Context
,
907 (VOID
*)PeiS3ResumeState
,
908 (VOID
*)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
918 Restores the platform to its preboot configuration for an S3 resume and
919 jumps to the OS waking vector.
921 This function will restore the platform to its pre-boot configuration that was
922 pre-stored in the boot script table and transfer control to OS waking vector.
923 Upon invocation, this function is responsible for locating the following
924 information before jumping to OS waking vector:
927 - any other information that it needs
929 The S3RestoreConfig() function then executes the pre-stored boot script table
930 and transitions the platform to the pre-boot state. The boot script is recorded
931 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
932 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
933 transfers control to the OS waking vector. If the OS supports only a real-mode
934 waking vector, this function will switch from flat mode to real mode before
935 jumping to the waking vector. If all platform pre-boot configurations are
936 successfully restored and all other necessary information is ready, this
937 function will never return and instead will directly jump to the OS waking
938 vector. If this function returns, it indicates that the attempt to resume
939 from the ACPI S3 sleep state failed.
941 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
943 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
944 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
945 resume boot path could not be located.
951 IN EFI_PEI_S3_RESUME2_PPI
*This
955 PEI_SMM_ACCESS_PPI
*SmmAccess
;
957 ACPI_S3_CONTEXT
*AcpiS3Context
;
958 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable
;
959 EFI_PHYSICAL_ADDRESS TempAcpiS3Context
;
960 BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
;
962 EFI_SMRAM_DESCRIPTOR
*SmramDescriptor
;
963 SMM_S3_RESUME_STATE
*SmmS3ResumeState
;
965 BOOLEAN Build4GPageTableOnly
;
966 BOOLEAN InterruptStatus
;
968 TempAcpiS3Context
= 0;
969 TempEfiBootScriptExecutorVariable
= 0;
971 DEBUG ((DEBUG_INFO
, "Enter S3 PEIM\r\n"));
973 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
974 Status
= RestoreLockBox (
975 &gEfiAcpiVariableGuid
,
979 ASSERT_EFI_ERROR (Status
);
981 Status
= RestoreLockBox (
982 &gEfiAcpiS3ContextGuid
,
986 ASSERT_EFI_ERROR (Status
);
988 AcpiS3Context
= (ACPI_S3_CONTEXT
*)(UINTN
)TempAcpiS3Context
;
989 ASSERT (AcpiS3Context
!= NULL
);
991 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
992 Status
= RestoreLockBox (
993 &gEfiBootScriptExecutorVariableGuid
,
994 &TempEfiBootScriptExecutorVariable
,
997 ASSERT_EFI_ERROR (Status
);
999 Status
= RestoreLockBox (
1000 &gEfiBootScriptExecutorContextGuid
,
1004 ASSERT_EFI_ERROR (Status
);
1006 EfiBootScriptExecutorVariable
= (BOOT_SCRIPT_EXECUTOR_VARIABLE
*) (UINTN
) TempEfiBootScriptExecutorVariable
;
1007 ASSERT (EfiBootScriptExecutorVariable
!= NULL
);
1009 DEBUG (( DEBUG_INFO
, "AcpiS3Context = %x\n", AcpiS3Context
));
1010 DEBUG (( DEBUG_INFO
, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
)))->FirmwareWakingVector
));
1011 DEBUG (( DEBUG_INFO
, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context
->AcpiFacsTable
));
1012 DEBUG (( DEBUG_INFO
, "AcpiS3Context->IdtrProfile = %x\n", AcpiS3Context
->IdtrProfile
));
1013 DEBUG (( DEBUG_INFO
, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context
->S3NvsPageTableAddress
));
1014 DEBUG (( DEBUG_INFO
, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context
->S3DebugBufferAddress
));
1015 DEBUG (( DEBUG_INFO
, "AcpiS3Context->BootScriptStackBase = %x\n", AcpiS3Context
->BootScriptStackBase
));
1016 DEBUG (( DEBUG_INFO
, "AcpiS3Context->BootScriptStackSize = %x\n", AcpiS3Context
->BootScriptStackSize
));
1017 DEBUG (( DEBUG_INFO
, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
));
1020 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.
1021 // Script dispatch image and context (parameter) are handled by platform.
1022 // We just use restore all lock box in place, no need restore one by one.
1024 Status
= RestoreAllLockBoxInPlace ();
1025 ASSERT_EFI_ERROR (Status
);
1026 if (EFI_ERROR (Status
)) {
1031 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
1033 // Need reconstruct page table here, since we do not trust ACPINvs.
1035 if (IsLongModeWakingVector (AcpiS3Context
)) {
1036 Build4GPageTableOnly
= FALSE
;
1038 Build4GPageTableOnly
= TRUE
;
1040 RestoreS3PageTables ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
, Build4GPageTableOnly
);
1044 // Attempt to use content from SMRAM first
1046 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
1047 if (GuidHob
!= NULL
) {
1048 Status
= PeiServicesLocatePpi (
1049 &gPeiSmmAccessPpiGuid
,
1052 (VOID
**) &SmmAccess
1054 for (Index
= 0; !EFI_ERROR (Status
); Index
++) {
1055 Status
= SmmAccess
->Open ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
1058 SmramDescriptor
= (EFI_SMRAM_DESCRIPTOR
*) GET_GUID_HOB_DATA (GuidHob
);
1059 SmmS3ResumeState
= (SMM_S3_RESUME_STATE
*)(UINTN
)SmramDescriptor
->CpuStart
;
1061 SmmS3ResumeState
->ReturnCs
= AsmReadCs ();
1062 SmmS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeExecuteBootScript
;
1063 SmmS3ResumeState
->ReturnContext1
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AcpiS3Context
;
1064 SmmS3ResumeState
->ReturnContext2
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)EfiBootScriptExecutorVariable
;
1065 SmmS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
1067 DEBUG (( DEBUG_INFO
, "SMM S3 Signature = %x\n", SmmS3ResumeState
->Signature
));
1068 DEBUG (( DEBUG_INFO
, "SMM S3 Stack Base = %x\n", SmmS3ResumeState
->SmmS3StackBase
));
1069 DEBUG (( DEBUG_INFO
, "SMM S3 Stack Size = %x\n", SmmS3ResumeState
->SmmS3StackSize
));
1070 DEBUG (( DEBUG_INFO
, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState
->SmmS3ResumeEntryPoint
));
1071 DEBUG (( DEBUG_INFO
, "SMM S3 CR0 = %x\n", SmmS3ResumeState
->SmmS3Cr0
));
1072 DEBUG (( DEBUG_INFO
, "SMM S3 CR3 = %x\n", SmmS3ResumeState
->SmmS3Cr3
));
1073 DEBUG (( DEBUG_INFO
, "SMM S3 CR4 = %x\n", SmmS3ResumeState
->SmmS3Cr4
));
1074 DEBUG (( DEBUG_INFO
, "SMM S3 Return CS = %x\n", SmmS3ResumeState
->ReturnCs
));
1075 DEBUG (( DEBUG_INFO
, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState
->ReturnEntryPoint
));
1076 DEBUG (( DEBUG_INFO
, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState
->ReturnContext1
));
1077 DEBUG (( DEBUG_INFO
, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState
->ReturnContext2
));
1078 DEBUG (( DEBUG_INFO
, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState
->ReturnStackPointer
));
1079 DEBUG (( DEBUG_INFO
, "SMM S3 Smst = %x\n", SmmS3ResumeState
->Smst
));
1081 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_32
) {
1083 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1084 (VOID
*)AcpiS3Context
,
1086 (VOID
*)(UINTN
)(SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
)
1089 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_64
) {
1091 // Switch to long mode to complete resume.
1094 InterruptStatus
= SaveAndDisableInterrupts ();
1096 // Need to make sure the GDT is loaded with values that support long mode and real mode.
1098 AsmWriteGdtr (&mGdt
);
1100 // update segment selectors per the new GDT.
1102 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
1104 // Restore interrupt state.
1106 SetInterruptState (InterruptStatus
);
1108 AsmWriteCr3 ((UINTN
)SmmS3ResumeState
->SmmS3Cr3
);
1111 // Disable interrupt of Debug timer, since IDT table cannot work in long mode.
1112 // NOTE: On x64 platforms, because DisablePaging64() will disable interrupts,
1113 // the code in S3ResumeExecuteBootScript() cannot be halted by soft debugger.
1115 SaveAndSetDebugTimerInterrupt (FALSE
);
1119 SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1120 (UINT64
)(UINTN
)AcpiS3Context
,
1122 SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
1128 S3ResumeExecuteBootScript (AcpiS3Context
, EfiBootScriptExecutorVariable
);
1132 Main entry for S3 Resume PEIM.
1134 This routine is to install EFI_PEI_S3_RESUME2_PPI.
1136 @param FileHandle Handle of the file being invoked.
1137 @param PeiServices Pointer to PEI Services table.
1139 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.
1144 PeimS3ResumeEntryPoint (
1145 IN EFI_PEI_FILE_HANDLE FileHandle
,
1146 IN CONST EFI_PEI_SERVICES
**PeiServices
1152 // Install S3 Resume Ppi
1154 Status
= (**PeiServices
).InstallPpi (PeiServices
, &mPpiList
);
1155 ASSERT_EFI_ERROR (Status
);