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
);
371 if (StartTicker
== 1) {
372 StartTicker
= StartValue
;
374 if (EndTicker
== 1) {
375 EndTicker
= StartValue
;
377 Ticker
= CountUp
? (EndTicker
- StartTicker
) : (StartTicker
- EndTicker
);
378 PerfData
->Duration
= (UINT32
) DivU64x32 (Ticker
, (UINT32
) Freq
);
381 // Only Record > 1ms performance data so that more big performance can be recorded.
383 if ((Ticker
> Freq
) && (++Index
>= PERF_PEI_ENTRY_MAX_NUM
)) {
385 // Reach the maximum number of PEI performance log entries.
391 PerfHeader
->S3EntryNum
= (UINT32
) Index
;
395 The function will check if current waking vector is long mode.
397 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
399 @retval TRUE Current context need long mode waking vector.
400 @retval FALSE Current context need not long mode waking vector.
403 IsLongModeWakingVector (
404 IN ACPI_S3_CONTEXT
*AcpiS3Context
407 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
409 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
410 if ((Facs
== NULL
) ||
411 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
412 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
413 // Something wrong with FACS
416 if (Facs
->XFirmwareWakingVector
!= 0) {
417 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
418 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
419 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
420 // Both BIOS and OS wants 64bit vector
421 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
430 Jump to OS waking vector.
431 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.
433 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
434 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
439 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
440 IN PEI_S3_RESUME_STATE
*PeiS3ResumeState
444 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
445 ASM_TRANSFER_CONTROL AsmTransferControl
;
447 UINTN TempStack
[0x10];
452 AsmWriteIdtr (&PeiS3ResumeState
->Idtr
);
454 if (PeiS3ResumeState
->ReturnStatus
!= EFI_SUCCESS
) {
456 // Report Status code that boot script execution is failed
459 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
460 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_BOOT_SCRIPT_ERROR
)
465 // NOTE: Because Debug Timer interrupt and system interrupts will be disabled
466 // in BootScriptExecuteDxe, the rest code in S3ResumeBootOs() cannot be halted
470 PERF_END (NULL
, "ScriptExec", NULL
, 0);
473 // Install BootScriptDonePpi
475 Status
= PeiServicesInstallPpi (&mPpiListPostScriptTable
);
476 ASSERT_EFI_ERROR (Status
);
479 // Get ACPI Table Address
481 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
483 if ((Facs
== NULL
) ||
484 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
485 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
487 // Report Status code that no valid vector is found
490 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
491 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
498 // Install EndOfPeiPpi
500 Status
= PeiServicesInstallPpi (&mPpiListEndOfPeiTable
);
501 ASSERT_EFI_ERROR (Status
);
504 // report status code on S3 resume
506 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_OS_WAKE
);
509 WriteToOsS3PerformanceData ();
512 AsmTransferControl
= (ASM_TRANSFER_CONTROL
)(UINTN
)PeiS3ResumeState
->AsmTransferControl
;
513 if (Facs
->XFirmwareWakingVector
!= 0) {
515 // Switch to native waking vector
517 TempStackTop
= (UINTN
)&TempStack
+ sizeof(TempStack
);
518 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
519 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
520 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
522 // X64 long mode waking vector
524 DEBUG (( EFI_D_ERROR
, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
525 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
528 Facs
->XFirmwareWakingVector
,
531 (UINT64
)(UINTN
)TempStackTop
535 // Report Status code that no valid waking vector is found
538 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
539 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
541 DEBUG (( EFI_D_ERROR
, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
548 // IA32 protected mode waking vector (Page disabled)
550 DEBUG (( EFI_D_ERROR
, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
552 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) Facs
->XFirmwareWakingVector
,
555 (VOID
*)(UINTN
)TempStackTop
560 // 16bit Realmode waking vector
562 DEBUG (( EFI_D_ERROR
, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN
)Facs
->FirmwareWakingVector
));
563 AsmTransferControl (Facs
->FirmwareWakingVector
, 0x0);
567 // Report Status code the failure of S3Resume
570 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
571 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
581 Restore S3 page table because we do not trust ACPINvs content.
582 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing.
584 @param S3NvsPageTableAddress PageTableAddress in ACPINvs
585 @param Build4GPageTableOnly If BIOS just build 4G page table only
588 RestoreS3PageTables (
589 IN UINTN S3NvsPageTableAddress
,
590 IN BOOLEAN Build4GPageTableOnly
593 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
596 UINT8 PhysicalAddressBits
;
597 EFI_PHYSICAL_ADDRESS PageAddress
;
598 UINTN IndexOfPml4Entries
;
599 UINTN IndexOfPdpEntries
;
600 UINTN IndexOfPageDirectoryEntries
;
601 UINT32 NumberOfPml4EntriesNeeded
;
602 UINT32 NumberOfPdpEntriesNeeded
;
603 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMapLevel4Entry
;
604 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMap
;
605 PAGE_MAP_AND_DIRECTORY_POINTER
*PageDirectoryPointerEntry
;
606 PAGE_TABLE_ENTRY
*PageDirectoryEntry
;
608 BOOLEAN Page1GSupport
;
609 PAGE_TABLE_1G_ENTRY
*PageDirectory1GEntry
;
612 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.
613 // The whole page table is too large to be saved in SMRAM.
615 // The assumption is : whole page table is allocated in CONTINOUS memory and CR3 points to TOP page.
617 DEBUG ((EFI_D_ERROR
, "S3NvsPageTableAddress - %x (%x)\n", (UINTN
)S3NvsPageTableAddress
, (UINTN
)Build4GPageTableOnly
));
620 // By architecture only one PageMapLevel4 exists - so lets allocate storgage for it.
622 PageMap
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
623 S3NvsPageTableAddress
+= SIZE_4KB
;
625 Page1GSupport
= FALSE
;
626 if (PcdGetBool(PcdUse1GPageTable
)) {
627 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
628 if (RegEax
>= 0x80000001) {
629 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
630 if ((RegEdx
& BIT26
) != 0) {
631 Page1GSupport
= TRUE
;
637 // Get physical address bits supported.
639 Hob
= GetFirstHob (EFI_HOB_TYPE_CPU
);
641 PhysicalAddressBits
= ((EFI_HOB_CPU
*) Hob
)->SizeOfMemorySpace
;
643 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
644 if (RegEax
>= 0x80000008) {
645 AsmCpuid (0x80000008, &RegEax
, NULL
, NULL
, NULL
);
646 PhysicalAddressBits
= (UINT8
) RegEax
;
648 PhysicalAddressBits
= 36;
653 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
655 ASSERT (PhysicalAddressBits
<= 52);
656 if (PhysicalAddressBits
> 48) {
657 PhysicalAddressBits
= 48;
661 // NOTE: In order to save time to create full page table, we just create 4G page table by default.
662 // And let PF handler in BootScript driver to create more on request.
664 if (Build4GPageTableOnly
) {
665 PhysicalAddressBits
= 32;
666 ZeroMem (PageMap
, EFI_PAGES_TO_SIZE(2));
669 // Calculate the table entries needed.
671 if (PhysicalAddressBits
<= 39) {
672 NumberOfPml4EntriesNeeded
= 1;
673 NumberOfPdpEntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 30));
675 NumberOfPml4EntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 39));
676 NumberOfPdpEntriesNeeded
= 512;
679 PageMapLevel4Entry
= PageMap
;
681 for (IndexOfPml4Entries
= 0; IndexOfPml4Entries
< NumberOfPml4EntriesNeeded
; IndexOfPml4Entries
++, PageMapLevel4Entry
++) {
683 // Each PML4 entry points to a page of Page Directory Pointer entires.
684 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.
686 PageDirectoryPointerEntry
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
687 S3NvsPageTableAddress
+= SIZE_4KB
;
692 PageMapLevel4Entry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryPointerEntry
;
693 PageMapLevel4Entry
->Bits
.ReadWrite
= 1;
694 PageMapLevel4Entry
->Bits
.Present
= 1;
697 PageDirectory1GEntry
= (VOID
*) PageDirectoryPointerEntry
;
699 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectory1GEntry
++, PageAddress
+= SIZE_1GB
) {
701 // Fill in the Page Directory entries
703 PageDirectory1GEntry
->Uint64
= (UINT64
)PageAddress
;
704 PageDirectory1GEntry
->Bits
.ReadWrite
= 1;
705 PageDirectory1GEntry
->Bits
.Present
= 1;
706 PageDirectory1GEntry
->Bits
.MustBe1
= 1;
709 for (IndexOfPdpEntries
= 0; IndexOfPdpEntries
< NumberOfPdpEntriesNeeded
; IndexOfPdpEntries
++, PageDirectoryPointerEntry
++) {
711 // Each Directory Pointer entries points to a page of Page Directory entires.
712 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.
714 PageDirectoryEntry
= (PAGE_TABLE_ENTRY
*)S3NvsPageTableAddress
;
715 S3NvsPageTableAddress
+= SIZE_4KB
;
718 // Fill in a Page Directory Pointer Entries
720 PageDirectoryPointerEntry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryEntry
;
721 PageDirectoryPointerEntry
->Bits
.ReadWrite
= 1;
722 PageDirectoryPointerEntry
->Bits
.Present
= 1;
724 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectoryEntry
++, PageAddress
+= SIZE_2MB
) {
726 // Fill in the Page Directory entries
728 PageDirectoryEntry
->Uint64
= (UINT64
)PageAddress
;
729 PageDirectoryEntry
->Bits
.ReadWrite
= 1;
730 PageDirectoryEntry
->Bits
.Present
= 1;
731 PageDirectoryEntry
->Bits
.MustBe1
= 1;
739 // If DXE is running 32-bit mode, no need to establish page table.
746 Jump to boot script executor driver.
748 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.
750 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
751 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in
752 boot script execute driver
756 S3ResumeExecuteBootScript (
757 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
758 IN BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
762 PEI_SMM_ACCESS_PPI
*SmmAccess
;
765 IA32_DESCRIPTOR
*IdtDescriptor
;
767 PEI_S3_RESUME_STATE
*PeiS3ResumeState
;
768 BOOLEAN InterruptStatus
;
770 DEBUG ((EFI_D_ERROR
, "S3ResumeExecuteBootScript()\n"));
773 // Attempt to use content from SMRAM first
775 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
776 if (GuidHob
!= NULL
) {
778 // Last step for SMM - send SMI for initialization
784 SendSmiIpiAllExcludingSelf ();
788 SendSmiIpi (GetApicId ());
790 Status
= PeiServicesLocatePpi (
791 &gPeiSmmAccessPpiGuid
,
796 if (!EFI_ERROR (Status
)) {
797 DEBUG ((EFI_D_ERROR
, "Close all SMRAM regions before executing boot script\n"));
799 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
800 Status
= SmmAccess
->Close ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
803 DEBUG ((EFI_D_ERROR
, "Lock all SMRAM regions before executing boot script\n"));
805 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
806 Status
= SmmAccess
->Lock ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
811 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
812 AsmWriteCr3 ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
);
815 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport
)) {
817 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices
818 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)).
820 IdtDescriptor
= (IA32_DESCRIPTOR
*) (UINTN
) (AcpiS3Context
->IdtrProfile
);
822 // Make sure the newly allcated IDT align with 16-bytes
824 IdtBuffer
= AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor
->Limit
+ 1) + 16));
825 ASSERT (IdtBuffer
!= NULL
);
827 // Additional 16 bytes allocated to save IA32 IDT descriptor and Pei Service Table Pointer
828 // IA32 IDT descriptor will be used to setup IA32 IDT table for 32-bit Framework Boot Script code
830 ZeroMem (IdtBuffer
, 16);
831 AsmReadIdtr ((IA32_DESCRIPTOR
*)IdtBuffer
);
832 CopyMem ((VOID
*)((UINT8
*)IdtBuffer
+ 16),(VOID
*)(IdtDescriptor
->Base
), (IdtDescriptor
->Limit
+ 1));
833 IdtDescriptor
->Base
= (UINTN
)((UINT8
*)IdtBuffer
+ 16);
834 *(UINTN
*)(IdtDescriptor
->Base
- sizeof(UINTN
)) = (UINTN
)GetPeiServicesTablePointer ();
837 InterruptStatus
= SaveAndDisableInterrupts ();
839 // Need to make sure the GDT is loaded with values that support long mode and real mode.
841 AsmWriteGdtr (&mGdt
);
843 // update segment selectors per the new GDT.
845 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
847 // Restore interrupt state.
849 SetInterruptState (InterruptStatus
);
852 // Prepare data for return back
854 PeiS3ResumeState
= AllocatePool (sizeof(*PeiS3ResumeState
));
855 ASSERT (PeiS3ResumeState
!= NULL
);
856 DEBUG (( EFI_D_ERROR
, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState
));
857 PeiS3ResumeState
->ReturnCs
= 0x10;
858 PeiS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeBootOs
;
859 PeiS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
863 AsmReadIdtr (&PeiS3ResumeState
->Idtr
);
866 // Report Status Code to indicate S3 boot script execution
868 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_S3_BOOT_SCRIPT
);
870 PERF_START (NULL
, "ScriptExec", NULL
, 0);
872 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
876 DEBUG (( EFI_D_ERROR
, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));
879 // Switch to long mode to complete resume.
883 EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
884 (UINT64
)(UINTN
)AcpiS3Context
,
885 (UINT64
)(UINTN
)PeiS3ResumeState
,
886 (UINT64
)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
892 DEBUG (( EFI_D_ERROR
, "transfer control to Standalone Boot Script Executor\r\n"));
894 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
895 (VOID
*)AcpiS3Context
,
896 (VOID
*)PeiS3ResumeState
,
897 (VOID
*)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
907 Restores the platform to its preboot configuration for an S3 resume and
908 jumps to the OS waking vector.
910 This function will restore the platform to its pre-boot configuration that was
911 pre-stored in the boot script table and transfer control to OS waking vector.
912 Upon invocation, this function is responsible for locating the following
913 information before jumping to OS waking vector:
916 - any other information that it needs
918 The S3RestoreConfig() function then executes the pre-stored boot script table
919 and transitions the platform to the pre-boot state. The boot script is recorded
920 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
921 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
922 transfers control to the OS waking vector. If the OS supports only a real-mode
923 waking vector, this function will switch from flat mode to real mode before
924 jumping to the waking vector. If all platform pre-boot configurations are
925 successfully restored and all other necessary information is ready, this
926 function will never return and instead will directly jump to the OS waking
927 vector. If this function returns, it indicates that the attempt to resume
928 from the ACPI S3 sleep state failed.
930 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
932 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
933 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
934 resume boot path could not be located.
940 IN EFI_PEI_S3_RESUME2_PPI
*This
944 PEI_SMM_ACCESS_PPI
*SmmAccess
;
946 ACPI_S3_CONTEXT
*AcpiS3Context
;
947 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable
;
948 EFI_PHYSICAL_ADDRESS TempAcpiS3Context
;
949 BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
;
951 EFI_SMRAM_DESCRIPTOR
*SmramDescriptor
;
952 SMM_S3_RESUME_STATE
*SmmS3ResumeState
;
954 BOOLEAN Build4GPageTableOnly
;
955 BOOLEAN InterruptStatus
;
957 TempAcpiS3Context
= 0;
958 TempEfiBootScriptExecutorVariable
= 0;
960 DEBUG ((EFI_D_ERROR
, "Enter S3 PEIM\r\n"));
962 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
963 Status
= RestoreLockBox (
964 &gEfiAcpiVariableGuid
,
968 ASSERT_EFI_ERROR (Status
);
970 Status
= RestoreLockBox (
971 &gEfiAcpiS3ContextGuid
,
975 ASSERT_EFI_ERROR (Status
);
977 AcpiS3Context
= (ACPI_S3_CONTEXT
*)(UINTN
)TempAcpiS3Context
;
978 ASSERT (AcpiS3Context
!= NULL
);
980 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
981 Status
= RestoreLockBox (
982 &gEfiBootScriptExecutorVariableGuid
,
983 &TempEfiBootScriptExecutorVariable
,
986 ASSERT_EFI_ERROR (Status
);
988 Status
= RestoreLockBox (
989 &gEfiBootScriptExecutorContextGuid
,
993 ASSERT_EFI_ERROR (Status
);
995 EfiBootScriptExecutorVariable
= (BOOT_SCRIPT_EXECUTOR_VARIABLE
*) (UINTN
) TempEfiBootScriptExecutorVariable
;
996 ASSERT (EfiBootScriptExecutorVariable
!= NULL
);
998 DEBUG (( EFI_D_ERROR
, "AcpiS3Context = %x\n", AcpiS3Context
));
999 DEBUG (( EFI_D_ERROR
, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
)))->FirmwareWakingVector
));
1000 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context
->AcpiFacsTable
));
1001 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->IdtrProfile = %x\n", AcpiS3Context
->IdtrProfile
));
1002 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context
->S3NvsPageTableAddress
));
1003 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context
->S3DebugBufferAddress
));
1004 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->BootScriptStackBase = %x\n", AcpiS3Context
->BootScriptStackBase
));
1005 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->BootScriptStackSize = %x\n", AcpiS3Context
->BootScriptStackSize
));
1006 DEBUG (( EFI_D_ERROR
, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
));
1009 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.
1010 // Script dispatch image and context (parameter) are handled by platform.
1011 // We just use restore all lock box in place, no need restore one by one.
1013 Status
= RestoreAllLockBoxInPlace ();
1014 ASSERT_EFI_ERROR (Status
);
1015 if (EFI_ERROR (Status
)) {
1020 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
1022 // Need reconstruct page table here, since we do not trust ACPINvs.
1024 if (IsLongModeWakingVector (AcpiS3Context
)) {
1025 Build4GPageTableOnly
= FALSE
;
1027 Build4GPageTableOnly
= TRUE
;
1029 RestoreS3PageTables ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
, Build4GPageTableOnly
);
1033 // Attempt to use content from SMRAM first
1035 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
1036 if (GuidHob
!= NULL
) {
1037 Status
= PeiServicesLocatePpi (
1038 &gPeiSmmAccessPpiGuid
,
1041 (VOID
**) &SmmAccess
1043 for (Index
= 0; !EFI_ERROR (Status
); Index
++) {
1044 Status
= SmmAccess
->Open ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
1047 SmramDescriptor
= (EFI_SMRAM_DESCRIPTOR
*) GET_GUID_HOB_DATA (GuidHob
);
1048 SmmS3ResumeState
= (SMM_S3_RESUME_STATE
*)(UINTN
)SmramDescriptor
->CpuStart
;
1050 SmmS3ResumeState
->ReturnCs
= AsmReadCs ();
1051 SmmS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeExecuteBootScript
;
1052 SmmS3ResumeState
->ReturnContext1
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AcpiS3Context
;
1053 SmmS3ResumeState
->ReturnContext2
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)EfiBootScriptExecutorVariable
;
1054 SmmS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
1056 DEBUG (( EFI_D_ERROR
, "SMM S3 Signature = %x\n", SmmS3ResumeState
->Signature
));
1057 DEBUG (( EFI_D_ERROR
, "SMM S3 Stack Base = %x\n", SmmS3ResumeState
->SmmS3StackBase
));
1058 DEBUG (( EFI_D_ERROR
, "SMM S3 Stack Size = %x\n", SmmS3ResumeState
->SmmS3StackSize
));
1059 DEBUG (( EFI_D_ERROR
, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState
->SmmS3ResumeEntryPoint
));
1060 DEBUG (( EFI_D_ERROR
, "SMM S3 CR0 = %x\n", SmmS3ResumeState
->SmmS3Cr0
));
1061 DEBUG (( EFI_D_ERROR
, "SMM S3 CR3 = %x\n", SmmS3ResumeState
->SmmS3Cr3
));
1062 DEBUG (( EFI_D_ERROR
, "SMM S3 CR4 = %x\n", SmmS3ResumeState
->SmmS3Cr4
));
1063 DEBUG (( EFI_D_ERROR
, "SMM S3 Return CS = %x\n", SmmS3ResumeState
->ReturnCs
));
1064 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState
->ReturnEntryPoint
));
1065 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState
->ReturnContext1
));
1066 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState
->ReturnContext2
));
1067 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState
->ReturnStackPointer
));
1068 DEBUG (( EFI_D_ERROR
, "SMM S3 Smst = %x\n", SmmS3ResumeState
->Smst
));
1070 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_32
) {
1072 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1073 (VOID
*)AcpiS3Context
,
1075 (VOID
*)(UINTN
)(SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
)
1078 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_64
) {
1080 // Switch to long mode to complete resume.
1083 InterruptStatus
= SaveAndDisableInterrupts ();
1085 // Need to make sure the GDT is loaded with values that support long mode and real mode.
1087 AsmWriteGdtr (&mGdt
);
1089 // update segment selectors per the new GDT.
1091 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
1093 // Restore interrupt state.
1095 SetInterruptState (InterruptStatus
);
1097 AsmWriteCr3 ((UINTN
)SmmS3ResumeState
->SmmS3Cr3
);
1100 // Disable interrupt of Debug timer, since IDT table cannot work in long mode.
1101 // NOTE: On x64 platforms, because DisablePaging64() will disable interrupts,
1102 // the code in S3ResumeExecuteBootScript() cannot be halted by soft debugger.
1104 SaveAndSetDebugTimerInterrupt (FALSE
);
1108 SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1109 (UINT64
)(UINTN
)AcpiS3Context
,
1111 SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
1117 S3ResumeExecuteBootScript (AcpiS3Context
, EfiBootScriptExecutorVariable
);
1121 Main entry for S3 Resume PEIM.
1123 This routine is to install EFI_PEI_S3_RESUME2_PPI.
1125 @param FileHandle Handle of the file being invoked.
1126 @param PeiServices Pointer to PEI Services table.
1128 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.
1133 PeimS3ResumeEntryPoint (
1134 IN EFI_PEI_FILE_HANDLE FileHandle
,
1135 IN CONST EFI_PEI_SERVICES
**PeiServices
1141 // Install S3 Resume Ppi
1143 Status
= (**PeiServices
).InstallPpi (PeiServices
, &mPpiList
);
1144 ASSERT_EFI_ERROR (Status
);