2 This module produces the EFI_PEI_S3_RESUME_PPI.
3 This module works with StandAloneBootScriptExecutor to S3 resume to OS.
4 This module will excute the boot script saved during last boot and after that,
5 control is passed to OS waking up handler.
7 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials
10 are licensed and made available under the terms and conditions
11 of the BSD License which accompanies this distribution. The
12 full text of the license may be found at
13 http://opensource.org/licenses/bsd-license.php
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #include <Guid/AcpiS3Context.h>
23 #include <Guid/BootScriptExecutorVariable.h>
24 #include <Guid/Performance.h>
25 #include <Ppi/ReadOnlyVariable2.h>
26 #include <Ppi/S3Resume2.h>
27 #include <Ppi/SmmAccess.h>
28 #include <Ppi/PostBootScriptTable.h>
29 #include <Ppi/EndOfPeiPhase.h>
31 #include <Library/DebugLib.h>
32 #include <Library/BaseLib.h>
33 #include <Library/TimerLib.h>
34 #include <Library/PeimEntryPoint.h>
35 #include <Library/PeiServicesLib.h>
36 #include <Library/HobLib.h>
37 #include <Library/PerformanceLib.h>
38 #include <Library/PeiServicesTablePointerLib.h>
39 #include <Library/IoLib.h>
40 #include <Library/BaseMemoryLib.h>
41 #include <Library/MemoryAllocationLib.h>
42 #include <Library/PcdLib.h>
43 #include <Library/DebugAgentLib.h>
44 #include <Library/LocalApicLib.h>
45 #include <Library/ReportStatusCodeLib.h>
46 #include <Library/PrintLib.h>
47 #include <Library/HobLib.h>
48 #include <Library/LockBoxLib.h>
49 #include <IndustryStandard/Acpi.h>
52 This macro aligns the address of a variable with auto storage
53 duration down to CPU_STACK_ALIGNMENT.
55 Since the stack grows downward, the result preserves more of the
56 stack than the original address (or the same amount), not less.
58 #define STACK_ALIGN_DOWN(Ptr) \
59 ((UINTN)(Ptr) & ~(UINTN)(CPU_STACK_ALIGNMENT - 1))
74 UINT32 DefaultSize
: 1;
75 UINT32 Granularity
: 1;
82 // Page-Map Level-4 Offset (PML4) and
83 // Page-Directory-Pointer Offset (PDPE) entries 4K & 2MB
87 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
88 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
89 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
90 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
91 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
92 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
93 UINT64 Reserved
:1; // Reserved
94 UINT64 MustBeZero
:2; // Must Be Zero
95 UINT64 Available
:3; // Available for use by system software
96 UINT64 PageTableBaseAddress
:40; // Page Table Base Address
97 UINT64 AvabilableHigh
:11; // Available for use by system software
98 UINT64 Nx
:1; // No Execute bit
101 } PAGE_MAP_AND_DIRECTORY_POINTER
;
104 // Page Table Entry 2MB
108 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
109 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
110 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
111 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
112 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
113 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
114 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
115 UINT64 MustBe1
:1; // Must be 1
116 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
117 UINT64 Available
:3; // Available for use by system software
119 UINT64 MustBeZero
:8; // Must be zero;
120 UINT64 PageTableBaseAddress
:31; // Page Table Base Address
121 UINT64 AvabilableHigh
:11; // Available for use by system software
122 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
128 // Page Table Entry 1GB
132 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
133 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
134 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
135 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
136 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
137 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
138 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
139 UINT64 MustBe1
:1; // Must be 1
140 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
141 UINT64 Available
:3; // Available for use by system software
143 UINT64 MustBeZero
:17; // Must be zero;
144 UINT64 PageTableBaseAddress
:22; // Page Table Base Address
145 UINT64 AvabilableHigh
:11; // Available for use by system software
146 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
149 } PAGE_TABLE_1G_ENTRY
;
154 // Function prototypes
157 a ASM function to transfer control to OS.
159 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table
160 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
164 (EFIAPI
*ASM_TRANSFER_CONTROL
) (
165 IN UINT32 S3WakingVector
,
166 IN UINT32 AcpiLowMemoryBase
170 Restores the platform to its preboot configuration for an S3 resume and
171 jumps to the OS waking vector.
173 This function will restore the platform to its pre-boot configuration that was
174 pre-stored in the boot script table and transfer control to OS waking vector.
175 Upon invocation, this function is responsible for locating the following
176 information before jumping to OS waking vector:
179 - any other information that it needs
181 The S3RestoreConfig() function then executes the pre-stored boot script table
182 and transitions the platform to the pre-boot state. The boot script is recorded
183 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
184 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
185 transfers control to the OS waking vector. If the OS supports only a real-mode
186 waking vector, this function will switch from flat mode to real mode before
187 jumping to the waking vector. If all platform pre-boot configurations are
188 successfully restored and all other necessary information is ready, this
189 function will never return and instead will directly jump to the OS waking
190 vector. If this function returns, it indicates that the attempt to resume
191 from the ACPI S3 sleep state failed.
193 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
195 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
196 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
197 resume boot path could not be located.
203 IN EFI_PEI_S3_RESUME2_PPI
*This
207 Set data segment selectors value including DS/ES/FS/GS/SS.
209 @param[in] SelectorValue Segment selector value to be set.
214 AsmSetDataSelectors (
215 IN UINT16 SelectorValue
221 EFI_PEI_S3_RESUME2_PPI mS3ResumePpi
= { S3RestoreConfig2
};
223 EFI_PEI_PPI_DESCRIPTOR mPpiList
= {
224 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
225 &gEfiPeiS3Resume2PpiGuid
,
229 EFI_PEI_PPI_DESCRIPTOR mPpiListPostScriptTable
= {
230 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
231 &gPeiPostScriptTablePpiGuid
,
235 EFI_PEI_PPI_DESCRIPTOR mPpiListEndOfPeiTable
= {
236 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
237 &gEfiEndOfPeiSignalPpiGuid
,
242 // Global Descriptor Table (GDT)
244 GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT mGdtEntries
[] = {
245 /* selector { Global Segment Descriptor } */
246 /* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
247 /* 0x08 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
248 /* 0x10 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
249 /* 0x18 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
250 /* 0x20 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
251 /* 0x28 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
252 /* 0x30 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
253 /* 0x38 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 1, 0, 1, 0}},
254 /* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
257 #define DATA_SEGEMENT_SELECTOR 0x18
262 GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt
= {
263 sizeof (mGdtEntries
) - 1,
268 Performance measure function to get S3 detailed performance data.
270 This function will getS3 detailed performance data and saved in pre-reserved ACPI memory.
273 WriteToOsS3PerformanceData (
278 EFI_PHYSICAL_ADDRESS mAcpiLowMemoryBase
;
279 PERF_HEADER
*PerfHeader
;
283 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariableServices
;
297 // Retrive time stamp count as early as possilbe
299 Ticker
= GetPerformanceCounter ();
301 Freq
= GetPerformanceCounterProperties (&StartValue
, &EndValue
);
303 Freq
= DivU64x32 (Freq
, 1000);
305 Status
= PeiServicesLocatePpi (
306 &gEfiPeiReadOnlyVariable2PpiGuid
,
309 (VOID
**) &VariableServices
311 if (EFI_ERROR (Status
)) {
315 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
316 Status
= VariableServices
->GetVariable (
319 &gPerformanceProtocolGuid
,
324 if (EFI_ERROR (Status
)) {
325 DEBUG ((EFI_D_ERROR
, "Fail to retrieve variable to log S3 performance data \n"));
329 PerfHeader
= (PERF_HEADER
*) (UINTN
) mAcpiLowMemoryBase
;
331 if (PerfHeader
->Signiture
!= PERFORMANCE_SIGNATURE
) {
332 DEBUG ((EFI_D_ERROR
, "Performance data in ACPI memory get corrupted! \n"));
337 // Record total S3 resume time.
339 if (EndValue
>= StartValue
) {
340 PerfHeader
->S3Resume
= Ticker
- StartValue
;
343 PerfHeader
->S3Resume
= StartValue
- Ticker
;
348 // Get S3 detailed performance data
352 while ((LogEntryKey
= GetPerformanceMeasurement (
359 if (EndTicker
!= 0) {
360 PerfData
= &PerfHeader
->S3Entry
[Index
];
363 // Use File Handle to specify the different performance log for PEIM.
364 // File Handle is the base address of PEIM FFS file.
366 if ((AsciiStrnCmp (Token
, "PEIM", PEI_PERFORMANCE_STRING_SIZE
) == 0) && (Handle
!= NULL
)) {
367 AsciiSPrint (PerfData
->Token
, PERF_TOKEN_LENGTH
, "0x%11p", Handle
);
369 AsciiStrnCpy (PerfData
->Token
, Token
, PERF_TOKEN_LENGTH
);
370 PerfData
->Token
[PERF_TOKEN_LENGTH
] = '\0';
372 if (StartTicker
== 1) {
373 StartTicker
= StartValue
;
375 if (EndTicker
== 1) {
376 EndTicker
= StartValue
;
378 Ticker
= CountUp
? (EndTicker
- StartTicker
) : (StartTicker
- EndTicker
);
379 PerfData
->Duration
= (UINT32
) DivU64x32 (Ticker
, (UINT32
) Freq
);
382 // Only Record > 1ms performance data so that more big performance can be recorded.
384 if ((Ticker
> Freq
) && (++Index
>= PERF_PEI_ENTRY_MAX_NUM
)) {
386 // Reach the maximum number of PEI performance log entries.
392 PerfHeader
->S3EntryNum
= (UINT32
) Index
;
396 The function will check if current waking vector is long mode.
398 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
400 @retval TRUE Current context need long mode waking vector.
401 @retval FALSE Current context need not long mode waking vector.
404 IsLongModeWakingVector (
405 IN ACPI_S3_CONTEXT
*AcpiS3Context
408 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
410 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
411 if ((Facs
== NULL
) ||
412 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
413 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
414 // Something wrong with FACS
417 if (Facs
->XFirmwareWakingVector
!= 0) {
418 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
419 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
420 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
421 // Both BIOS and OS wants 64bit vector
422 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
431 Jump to OS waking vector.
432 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.
434 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
435 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
440 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
441 IN PEI_S3_RESUME_STATE
*PeiS3ResumeState
445 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
446 ASM_TRANSFER_CONTROL AsmTransferControl
;
448 UINTN TempStack
[0x10];
453 AsmWriteIdtr (&PeiS3ResumeState
->Idtr
);
455 if (PeiS3ResumeState
->ReturnStatus
!= EFI_SUCCESS
) {
457 // Report Status code that boot script execution is failed
460 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
461 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_BOOT_SCRIPT_ERROR
)
466 // NOTE: Because Debug Timer interrupt and system interrupts will be disabled
467 // in BootScriptExecuteDxe, the rest code in S3ResumeBootOs() cannot be halted
471 PERF_END (NULL
, "ScriptExec", NULL
, 0);
474 // Install BootScriptDonePpi
476 Status
= PeiServicesInstallPpi (&mPpiListPostScriptTable
);
477 ASSERT_EFI_ERROR (Status
);
480 // Get ACPI Table Address
482 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
484 if ((Facs
== NULL
) ||
485 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
486 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
488 // Report Status code that no valid vector is found
491 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
492 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
499 // Install EndOfPeiPpi
501 Status
= PeiServicesInstallPpi (&mPpiListEndOfPeiTable
);
502 ASSERT_EFI_ERROR (Status
);
505 // report status code on S3 resume
507 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_OS_WAKE
);
510 WriteToOsS3PerformanceData ();
513 AsmTransferControl
= (ASM_TRANSFER_CONTROL
)(UINTN
)PeiS3ResumeState
->AsmTransferControl
;
514 if (Facs
->XFirmwareWakingVector
!= 0) {
516 // Switch to native waking vector
518 TempStackTop
= (UINTN
)&TempStack
+ sizeof(TempStack
);
519 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
520 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
521 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
523 // X64 long mode waking vector
525 DEBUG (( EFI_D_ERROR
, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
526 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
529 Facs
->XFirmwareWakingVector
,
532 (UINT64
)(UINTN
)TempStackTop
536 // Report Status code that no valid waking vector is found
539 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
540 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
542 DEBUG (( EFI_D_ERROR
, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
549 // IA32 protected mode waking vector (Page disabled)
551 DEBUG (( EFI_D_ERROR
, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
553 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) Facs
->XFirmwareWakingVector
,
556 (VOID
*)(UINTN
)TempStackTop
561 // 16bit Realmode waking vector
563 DEBUG (( EFI_D_ERROR
, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN
)Facs
->FirmwareWakingVector
));
564 AsmTransferControl (Facs
->FirmwareWakingVector
, 0x0);
568 // Report Status code the failure of S3Resume
571 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
572 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
582 Restore S3 page table because we do not trust ACPINvs content.
583 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing.
585 @param S3NvsPageTableAddress PageTableAddress in ACPINvs
586 @param Build4GPageTableOnly If BIOS just build 4G page table only
589 RestoreS3PageTables (
590 IN UINTN S3NvsPageTableAddress
,
591 IN BOOLEAN Build4GPageTableOnly
594 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
597 UINT8 PhysicalAddressBits
;
598 EFI_PHYSICAL_ADDRESS PageAddress
;
599 UINTN IndexOfPml4Entries
;
600 UINTN IndexOfPdpEntries
;
601 UINTN IndexOfPageDirectoryEntries
;
602 UINT32 NumberOfPml4EntriesNeeded
;
603 UINT32 NumberOfPdpEntriesNeeded
;
604 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMapLevel4Entry
;
605 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMap
;
606 PAGE_MAP_AND_DIRECTORY_POINTER
*PageDirectoryPointerEntry
;
607 PAGE_TABLE_ENTRY
*PageDirectoryEntry
;
609 BOOLEAN Page1GSupport
;
610 PAGE_TABLE_1G_ENTRY
*PageDirectory1GEntry
;
613 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.
614 // The whole page table is too large to be saved in SMRAM.
616 // The assumption is : whole page table is allocated in CONTINOUS memory and CR3 points to TOP page.
618 DEBUG ((EFI_D_ERROR
, "S3NvsPageTableAddress - %x (%x)\n", (UINTN
)S3NvsPageTableAddress
, (UINTN
)Build4GPageTableOnly
));
621 // By architecture only one PageMapLevel4 exists - so lets allocate storgage for it.
623 PageMap
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
624 S3NvsPageTableAddress
+= SIZE_4KB
;
626 Page1GSupport
= FALSE
;
627 if (PcdGetBool(PcdUse1GPageTable
)) {
628 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
629 if (RegEax
>= 0x80000001) {
630 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
631 if ((RegEdx
& BIT26
) != 0) {
632 Page1GSupport
= TRUE
;
638 // Get physical address bits supported.
640 Hob
= GetFirstHob (EFI_HOB_TYPE_CPU
);
642 PhysicalAddressBits
= ((EFI_HOB_CPU
*) Hob
)->SizeOfMemorySpace
;
644 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
645 if (RegEax
>= 0x80000008) {
646 AsmCpuid (0x80000008, &RegEax
, NULL
, NULL
, NULL
);
647 PhysicalAddressBits
= (UINT8
) RegEax
;
649 PhysicalAddressBits
= 36;
654 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
656 ASSERT (PhysicalAddressBits
<= 52);
657 if (PhysicalAddressBits
> 48) {
658 PhysicalAddressBits
= 48;
662 // NOTE: In order to save time to create full page table, we just create 4G page table by default.
663 // And let PF handler in BootScript driver to create more on request.
665 if (Build4GPageTableOnly
) {
666 PhysicalAddressBits
= 32;
667 ZeroMem (PageMap
, EFI_PAGES_TO_SIZE(2));
670 // Calculate the table entries needed.
672 if (PhysicalAddressBits
<= 39) {
673 NumberOfPml4EntriesNeeded
= 1;
674 NumberOfPdpEntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 30));
676 NumberOfPml4EntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 39));
677 NumberOfPdpEntriesNeeded
= 512;
680 PageMapLevel4Entry
= PageMap
;
682 for (IndexOfPml4Entries
= 0; IndexOfPml4Entries
< NumberOfPml4EntriesNeeded
; IndexOfPml4Entries
++, PageMapLevel4Entry
++) {
684 // Each PML4 entry points to a page of Page Directory Pointer entires.
685 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.
687 PageDirectoryPointerEntry
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
688 S3NvsPageTableAddress
+= SIZE_4KB
;
693 PageMapLevel4Entry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryPointerEntry
;
694 PageMapLevel4Entry
->Bits
.ReadWrite
= 1;
695 PageMapLevel4Entry
->Bits
.Present
= 1;
698 PageDirectory1GEntry
= (VOID
*) PageDirectoryPointerEntry
;
700 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectory1GEntry
++, PageAddress
+= SIZE_1GB
) {
702 // Fill in the Page Directory entries
704 PageDirectory1GEntry
->Uint64
= (UINT64
)PageAddress
;
705 PageDirectory1GEntry
->Bits
.ReadWrite
= 1;
706 PageDirectory1GEntry
->Bits
.Present
= 1;
707 PageDirectory1GEntry
->Bits
.MustBe1
= 1;
710 for (IndexOfPdpEntries
= 0; IndexOfPdpEntries
< NumberOfPdpEntriesNeeded
; IndexOfPdpEntries
++, PageDirectoryPointerEntry
++) {
712 // Each Directory Pointer entries points to a page of Page Directory entires.
713 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.
715 PageDirectoryEntry
= (PAGE_TABLE_ENTRY
*)S3NvsPageTableAddress
;
716 S3NvsPageTableAddress
+= SIZE_4KB
;
719 // Fill in a Page Directory Pointer Entries
721 PageDirectoryPointerEntry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryEntry
;
722 PageDirectoryPointerEntry
->Bits
.ReadWrite
= 1;
723 PageDirectoryPointerEntry
->Bits
.Present
= 1;
725 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectoryEntry
++, PageAddress
+= SIZE_2MB
) {
727 // Fill in the Page Directory entries
729 PageDirectoryEntry
->Uint64
= (UINT64
)PageAddress
;
730 PageDirectoryEntry
->Bits
.ReadWrite
= 1;
731 PageDirectoryEntry
->Bits
.Present
= 1;
732 PageDirectoryEntry
->Bits
.MustBe1
= 1;
740 // If DXE is running 32-bit mode, no need to establish page table.
747 Jump to boot script executor driver.
749 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.
751 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
752 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in
753 boot script execute driver
757 S3ResumeExecuteBootScript (
758 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
759 IN BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
763 PEI_SMM_ACCESS_PPI
*SmmAccess
;
766 IA32_DESCRIPTOR
*IdtDescriptor
;
768 PEI_S3_RESUME_STATE
*PeiS3ResumeState
;
769 BOOLEAN InterruptStatus
;
771 DEBUG ((EFI_D_ERROR
, "S3ResumeExecuteBootScript()\n"));
774 // Attempt to use content from SMRAM first
776 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
777 if (GuidHob
!= NULL
) {
779 // Last step for SMM - send SMI for initialization
785 SendSmiIpiAllExcludingSelf ();
789 SendSmiIpi (GetApicId ());
791 Status
= PeiServicesLocatePpi (
792 &gPeiSmmAccessPpiGuid
,
797 if (!EFI_ERROR (Status
)) {
798 DEBUG ((EFI_D_ERROR
, "Close all SMRAM regions before executing boot script\n"));
800 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
801 Status
= SmmAccess
->Close ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
804 DEBUG ((EFI_D_ERROR
, "Lock all SMRAM regions before executing boot script\n"));
806 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
807 Status
= SmmAccess
->Lock ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
812 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
813 AsmWriteCr3 ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
);
816 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport
)) {
818 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices
819 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)).
821 IdtDescriptor
= (IA32_DESCRIPTOR
*) (UINTN
) (AcpiS3Context
->IdtrProfile
);
823 // Make sure the newly allcated IDT align with 16-bytes
825 IdtBuffer
= AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor
->Limit
+ 1) + 16));
826 ASSERT (IdtBuffer
!= NULL
);
828 // Additional 16 bytes allocated to save IA32 IDT descriptor and Pei Service Table Pointer
829 // IA32 IDT descriptor will be used to setup IA32 IDT table for 32-bit Framework Boot Script code
831 ZeroMem (IdtBuffer
, 16);
832 AsmReadIdtr ((IA32_DESCRIPTOR
*)IdtBuffer
);
833 CopyMem ((VOID
*)((UINT8
*)IdtBuffer
+ 16),(VOID
*)(IdtDescriptor
->Base
), (IdtDescriptor
->Limit
+ 1));
834 IdtDescriptor
->Base
= (UINTN
)((UINT8
*)IdtBuffer
+ 16);
835 *(UINTN
*)(IdtDescriptor
->Base
- sizeof(UINTN
)) = (UINTN
)GetPeiServicesTablePointer ();
838 InterruptStatus
= SaveAndDisableInterrupts ();
840 // Need to make sure the GDT is loaded with values that support long mode and real mode.
842 AsmWriteGdtr (&mGdt
);
844 // update segment selectors per the new GDT.
846 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
848 // Restore interrupt state.
850 SetInterruptState (InterruptStatus
);
853 // Prepare data for return back
855 PeiS3ResumeState
= AllocatePool (sizeof(*PeiS3ResumeState
));
856 ASSERT (PeiS3ResumeState
!= NULL
);
857 DEBUG (( EFI_D_ERROR
, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState
));
858 PeiS3ResumeState
->ReturnCs
= 0x10;
859 PeiS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeBootOs
;
860 PeiS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
864 AsmReadIdtr (&PeiS3ResumeState
->Idtr
);
867 // Report Status Code to indicate S3 boot script execution
869 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_S3_BOOT_SCRIPT
);
871 PERF_START (NULL
, "ScriptExec", NULL
, 0);
873 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
877 DEBUG (( EFI_D_ERROR
, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));
880 // Switch to long mode to complete resume.
884 EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
885 (UINT64
)(UINTN
)AcpiS3Context
,
886 (UINT64
)(UINTN
)PeiS3ResumeState
,
887 (UINT64
)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
893 DEBUG (( EFI_D_ERROR
, "transfer control to Standalone Boot Script Executor\r\n"));
895 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
896 (VOID
*)AcpiS3Context
,
897 (VOID
*)PeiS3ResumeState
,
898 (VOID
*)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
908 Restores the platform to its preboot configuration for an S3 resume and
909 jumps to the OS waking vector.
911 This function will restore the platform to its pre-boot configuration that was
912 pre-stored in the boot script table and transfer control to OS waking vector.
913 Upon invocation, this function is responsible for locating the following
914 information before jumping to OS waking vector:
917 - any other information that it needs
919 The S3RestoreConfig() function then executes the pre-stored boot script table
920 and transitions the platform to the pre-boot state. The boot script is recorded
921 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
922 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
923 transfers control to the OS waking vector. If the OS supports only a real-mode
924 waking vector, this function will switch from flat mode to real mode before
925 jumping to the waking vector. If all platform pre-boot configurations are
926 successfully restored and all other necessary information is ready, this
927 function will never return and instead will directly jump to the OS waking
928 vector. If this function returns, it indicates that the attempt to resume
929 from the ACPI S3 sleep state failed.
931 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
933 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
934 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
935 resume boot path could not be located.
941 IN EFI_PEI_S3_RESUME2_PPI
*This
945 PEI_SMM_ACCESS_PPI
*SmmAccess
;
947 ACPI_S3_CONTEXT
*AcpiS3Context
;
948 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable
;
949 EFI_PHYSICAL_ADDRESS TempAcpiS3Context
;
950 BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
;
952 EFI_SMRAM_DESCRIPTOR
*SmramDescriptor
;
953 SMM_S3_RESUME_STATE
*SmmS3ResumeState
;
955 BOOLEAN Build4GPageTableOnly
;
956 BOOLEAN InterruptStatus
;
958 TempAcpiS3Context
= 0;
959 TempEfiBootScriptExecutorVariable
= 0;
961 DEBUG ((EFI_D_ERROR
, "Enter S3 PEIM\r\n"));
963 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
964 Status
= RestoreLockBox (
965 &gEfiAcpiVariableGuid
,
969 ASSERT_EFI_ERROR (Status
);
971 Status
= RestoreLockBox (
972 &gEfiAcpiS3ContextGuid
,
976 ASSERT_EFI_ERROR (Status
);
978 AcpiS3Context
= (ACPI_S3_CONTEXT
*)(UINTN
)TempAcpiS3Context
;
979 ASSERT (AcpiS3Context
!= NULL
);
981 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
982 Status
= RestoreLockBox (
983 &gEfiBootScriptExecutorVariableGuid
,
984 &TempEfiBootScriptExecutorVariable
,
987 ASSERT_EFI_ERROR (Status
);
989 Status
= RestoreLockBox (
990 &gEfiBootScriptExecutorContextGuid
,
994 ASSERT_EFI_ERROR (Status
);
996 EfiBootScriptExecutorVariable
= (BOOT_SCRIPT_EXECUTOR_VARIABLE
*) (UINTN
) TempEfiBootScriptExecutorVariable
;
997 ASSERT (EfiBootScriptExecutorVariable
!= NULL
);
999 DEBUG (( EFI_D_ERROR
, "AcpiS3Context = %x\n", AcpiS3Context
));
1000 DEBUG (( EFI_D_ERROR
, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
)))->FirmwareWakingVector
));
1001 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context
->AcpiFacsTable
));
1002 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->IdtrProfile = %x\n", AcpiS3Context
->IdtrProfile
));
1003 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context
->S3NvsPageTableAddress
));
1004 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context
->S3DebugBufferAddress
));
1005 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->BootScriptStackBase = %x\n", AcpiS3Context
->BootScriptStackBase
));
1006 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->BootScriptStackSize = %x\n", AcpiS3Context
->BootScriptStackSize
));
1007 DEBUG (( EFI_D_ERROR
, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
));
1010 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.
1011 // Script dispatch image and context (parameter) are handled by platform.
1012 // We just use restore all lock box in place, no need restore one by one.
1014 Status
= RestoreAllLockBoxInPlace ();
1015 ASSERT_EFI_ERROR (Status
);
1016 if (EFI_ERROR (Status
)) {
1021 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
1023 // Need reconstruct page table here, since we do not trust ACPINvs.
1025 if (IsLongModeWakingVector (AcpiS3Context
)) {
1026 Build4GPageTableOnly
= FALSE
;
1028 Build4GPageTableOnly
= TRUE
;
1030 RestoreS3PageTables ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
, Build4GPageTableOnly
);
1034 // Attempt to use content from SMRAM first
1036 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
1037 if (GuidHob
!= NULL
) {
1038 Status
= PeiServicesLocatePpi (
1039 &gPeiSmmAccessPpiGuid
,
1042 (VOID
**) &SmmAccess
1044 for (Index
= 0; !EFI_ERROR (Status
); Index
++) {
1045 Status
= SmmAccess
->Open ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
1048 SmramDescriptor
= (EFI_SMRAM_DESCRIPTOR
*) GET_GUID_HOB_DATA (GuidHob
);
1049 SmmS3ResumeState
= (SMM_S3_RESUME_STATE
*)(UINTN
)SmramDescriptor
->CpuStart
;
1051 SmmS3ResumeState
->ReturnCs
= AsmReadCs ();
1052 SmmS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeExecuteBootScript
;
1053 SmmS3ResumeState
->ReturnContext1
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AcpiS3Context
;
1054 SmmS3ResumeState
->ReturnContext2
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)EfiBootScriptExecutorVariable
;
1055 SmmS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
1057 DEBUG (( EFI_D_ERROR
, "SMM S3 Signature = %x\n", SmmS3ResumeState
->Signature
));
1058 DEBUG (( EFI_D_ERROR
, "SMM S3 Stack Base = %x\n", SmmS3ResumeState
->SmmS3StackBase
));
1059 DEBUG (( EFI_D_ERROR
, "SMM S3 Stack Size = %x\n", SmmS3ResumeState
->SmmS3StackSize
));
1060 DEBUG (( EFI_D_ERROR
, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState
->SmmS3ResumeEntryPoint
));
1061 DEBUG (( EFI_D_ERROR
, "SMM S3 CR0 = %x\n", SmmS3ResumeState
->SmmS3Cr0
));
1062 DEBUG (( EFI_D_ERROR
, "SMM S3 CR3 = %x\n", SmmS3ResumeState
->SmmS3Cr3
));
1063 DEBUG (( EFI_D_ERROR
, "SMM S3 CR4 = %x\n", SmmS3ResumeState
->SmmS3Cr4
));
1064 DEBUG (( EFI_D_ERROR
, "SMM S3 Return CS = %x\n", SmmS3ResumeState
->ReturnCs
));
1065 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState
->ReturnEntryPoint
));
1066 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState
->ReturnContext1
));
1067 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState
->ReturnContext2
));
1068 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState
->ReturnStackPointer
));
1069 DEBUG (( EFI_D_ERROR
, "SMM S3 Smst = %x\n", SmmS3ResumeState
->Smst
));
1071 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_32
) {
1073 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1074 (VOID
*)AcpiS3Context
,
1076 (VOID
*)(UINTN
)(SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
)
1079 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_64
) {
1081 // Switch to long mode to complete resume.
1084 InterruptStatus
= SaveAndDisableInterrupts ();
1086 // Need to make sure the GDT is loaded with values that support long mode and real mode.
1088 AsmWriteGdtr (&mGdt
);
1090 // update segment selectors per the new GDT.
1092 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
1094 // Restore interrupt state.
1096 SetInterruptState (InterruptStatus
);
1098 AsmWriteCr3 ((UINTN
)SmmS3ResumeState
->SmmS3Cr3
);
1101 // Disable interrupt of Debug timer, since IDT table cannot work in long mode.
1102 // NOTE: On x64 platforms, because DisablePaging64() will disable interrupts,
1103 // the code in S3ResumeExecuteBootScript() cannot be halted by soft debugger.
1105 SaveAndSetDebugTimerInterrupt (FALSE
);
1109 SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1110 (UINT64
)(UINTN
)AcpiS3Context
,
1112 SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
1118 S3ResumeExecuteBootScript (AcpiS3Context
, EfiBootScriptExecutorVariable
);
1122 Main entry for S3 Resume PEIM.
1124 This routine is to install EFI_PEI_S3_RESUME2_PPI.
1126 @param FileHandle Handle of the file being invoked.
1127 @param PeiServices Pointer to PEI Services table.
1129 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.
1134 PeimS3ResumeEntryPoint (
1135 IN EFI_PEI_FILE_HANDLE FileHandle
,
1136 IN CONST EFI_PEI_SERVICES
**PeiServices
1142 // Install S3 Resume Ppi
1144 Status
= (**PeiServices
).InstallPpi (PeiServices
, &mPpiList
);
1145 ASSERT_EFI_ERROR (Status
);