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 - 2011, 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>
64 UINT32 DefaultSize
: 1;
65 UINT32 Granularity
: 1;
72 // Page-Map Level-4 Offset (PML4) and
73 // Page-Directory-Pointer Offset (PDPE) entries 4K & 2MB
77 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
78 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
79 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
80 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
81 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
82 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
83 UINT64 Reserved
:1; // Reserved
84 UINT64 MustBeZero
:2; // Must Be Zero
85 UINT64 Available
:3; // Available for use by system software
86 UINT64 PageTableBaseAddress
:40; // Page Table Base Address
87 UINT64 AvabilableHigh
:11; // Available for use by system software
88 UINT64 Nx
:1; // No Execute bit
91 } PAGE_MAP_AND_DIRECTORY_POINTER
;
94 // Page Table Entry 2MB
98 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
99 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
100 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
101 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
102 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
103 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
104 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
105 UINT64 MustBe1
:1; // Must be 1
106 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
107 UINT64 Available
:3; // Available for use by system software
109 UINT64 MustBeZero
:8; // Must be zero;
110 UINT64 PageTableBaseAddress
:31; // Page Table Base Address
111 UINT64 AvabilableHigh
:11; // Available for use by system software
112 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
118 // Page Table Entry 1GB
122 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
123 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
124 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
125 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
126 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
127 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
128 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
129 UINT64 MustBe1
:1; // Must be 1
130 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
131 UINT64 Available
:3; // Available for use by system software
133 UINT64 MustBeZero
:17; // Must be zero;
134 UINT64 PageTableBaseAddress
:22; // Page Table Base Address
135 UINT64 AvabilableHigh
:11; // Available for use by system software
136 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
139 } PAGE_TABLE_1G_ENTRY
;
144 // Function prototypes
147 a ASM function to transfer control to OS.
149 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table
150 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
154 (EFIAPI
*ASM_TRANSFER_CONTROL
) (
155 IN UINT32 S3WakingVector
,
156 IN UINT32 AcpiLowMemoryBase
160 Restores the platform to its preboot configuration for an S3 resume and
161 jumps to the OS waking vector.
163 This function will restore the platform to its pre-boot configuration that was
164 pre-stored in the boot script table and transfer control to OS waking vector.
165 Upon invocation, this function is responsible for locating the following
166 information before jumping to OS waking vector:
169 - any other information that it needs
171 The S3RestoreConfig() function then executes the pre-stored boot script table
172 and transitions the platform to the pre-boot state. The boot script is recorded
173 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
174 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
175 transfers control to the OS waking vector. If the OS supports only a real-mode
176 waking vector, this function will switch from flat mode to real mode before
177 jumping to the waking vector. If all platform pre-boot configurations are
178 successfully restored and all other necessary information is ready, this
179 function will never return and instead will directly jump to the OS waking
180 vector. If this function returns, it indicates that the attempt to resume
181 from the ACPI S3 sleep state failed.
183 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
185 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
186 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
187 resume boot path could not be located.
193 IN EFI_PEI_S3_RESUME2_PPI
*This
199 EFI_PEI_S3_RESUME2_PPI mS3ResumePpi
= { S3RestoreConfig2
};
201 EFI_PEI_PPI_DESCRIPTOR mPpiList
= {
202 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
203 &gEfiPeiS3Resume2PpiGuid
,
207 EFI_PEI_PPI_DESCRIPTOR mPpiListPostScriptTable
= {
208 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
209 &gPeiPostScriptTablePpiGuid
,
213 EFI_PEI_PPI_DESCRIPTOR mPpiListEndOfPeiTable
= {
214 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
215 &gEfiEndOfPeiSignalPpiGuid
,
220 // Global Descriptor Table (GDT)
222 GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT mGdtEntries
[] = {
223 /* selector { Global Segment Descriptor } */
224 /* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
225 /* 0x08 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
226 /* 0x10 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
227 /* 0x18 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
228 /* 0x20 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
229 /* 0x28 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
230 /* 0x30 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
231 /* 0x38 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 1, 0, 1, 0}},
232 /* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
238 GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt
= {
239 sizeof (mGdtEntries
) - 1,
244 Performance measure function to get S3 detailed performance data.
246 This function will getS3 detailed performance data and saved in pre-reserved ACPI memory.
249 WriteToOsS3PerformanceData (
254 EFI_PHYSICAL_ADDRESS mAcpiLowMemoryBase
;
255 PERF_HEADER
*PerfHeader
;
259 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariableServices
;
273 // Retrive time stamp count as early as possilbe
275 Ticker
= GetPerformanceCounter ();
277 Freq
= GetPerformanceCounterProperties (&StartValue
, &EndValue
);
279 Freq
= DivU64x32 (Freq
, 1000);
281 Status
= PeiServicesLocatePpi (
282 &gEfiPeiReadOnlyVariable2PpiGuid
,
285 (VOID
**) &VariableServices
287 ASSERT_EFI_ERROR (Status
);
289 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
290 Status
= VariableServices
->GetVariable (
293 &gPerformanceProtocolGuid
,
298 if (EFI_ERROR (Status
)) {
299 DEBUG ((EFI_D_ERROR
, "Fail to retrieve variable to log S3 performance data \n"));
303 PerfHeader
= (PERF_HEADER
*) (UINTN
) mAcpiLowMemoryBase
;
305 if (PerfHeader
->Signiture
!= PERFORMANCE_SIGNATURE
) {
306 DEBUG ((EFI_D_ERROR
, "Performance data in ACPI memory get corrupted! \n"));
311 // Record total S3 resume time.
313 if (EndValue
>= StartValue
) {
314 PerfHeader
->S3Resume
= Ticker
- StartValue
;
317 PerfHeader
->S3Resume
= StartValue
- Ticker
;
322 // Get S3 detailed performance data
326 while ((LogEntryKey
= GetPerformanceMeasurement (
333 if (EndTicker
!= 0) {
334 PerfData
= &PerfHeader
->S3Entry
[Index
];
337 // Use File Handle to specify the different performance log for PEIM.
338 // File Handle is the base address of PEIM FFS file.
340 if ((AsciiStrnCmp (Token
, "PEIM", PEI_PERFORMANCE_STRING_SIZE
) == 0) && (Handle
!= NULL
)) {
341 AsciiSPrint (PerfData
->Token
, PERF_TOKEN_LENGTH
, "0x%11p", Handle
);
343 AsciiStrnCpy (PerfData
->Token
, Token
, PERF_TOKEN_LENGTH
);
345 if (StartTicker
== 1) {
346 StartTicker
= StartValue
;
348 if (EndTicker
== 1) {
349 EndTicker
= StartValue
;
351 Ticker
= CountUp
? (EndTicker
- StartTicker
) : (StartTicker
- EndTicker
);
352 PerfData
->Duration
= (UINT32
) DivU64x32 (Ticker
, (UINT32
) Freq
);
355 // Only Record > 1ms performance data so that more big performance can be recorded.
357 if ((Ticker
> Freq
) && (++Index
>= PERF_PEI_ENTRY_MAX_NUM
)) {
359 // Reach the maximum number of PEI performance log entries.
365 PerfHeader
->S3EntryNum
= (UINT32
) Index
;
369 Jump to OS waking vector.
370 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.
372 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
373 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
378 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
379 IN PEI_S3_RESUME_STATE
*PeiS3ResumeState
383 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
384 ASM_TRANSFER_CONTROL AsmTransferControl
;
386 UINTN TempStack
[0x10];
391 AsmWriteIdtr (&PeiS3ResumeState
->Idtr
);
394 // Install BootScriptDonePpi
396 Status
= PeiServicesInstallPpi (&mPpiListPostScriptTable
);
397 ASSERT_EFI_ERROR (Status
);
400 // Get ACPI Table Address
402 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
404 if ((Facs
== NULL
) ||
405 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
406 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
412 // report status code on S3 resume
414 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_OS_WAKE
);
417 // Install EndOfPeiPpi
419 Status
= PeiServicesInstallPpi (&mPpiListEndOfPeiTable
);
420 ASSERT_EFI_ERROR (Status
);
423 WriteToOsS3PerformanceData ();
426 AsmTransferControl
= (ASM_TRANSFER_CONTROL
)(UINTN
)PeiS3ResumeState
->AsmTransferControl
;
427 if (Facs
->XFirmwareWakingVector
!= 0) {
429 // Switch to native waking vector
431 TempStackTop
= (UINTN
)&TempStack
+ sizeof(TempStack
);
432 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
433 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
434 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
436 // X64 long mode waking vector
438 DEBUG (( EFI_D_ERROR
, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
439 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
442 Facs
->XFirmwareWakingVector
,
445 (UINT64
)(UINTN
)TempStackTop
448 DEBUG (( EFI_D_ERROR
, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
453 // IA32 protected mode waking vector (Page disabled)
455 DEBUG (( EFI_D_ERROR
, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
457 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) Facs
->XFirmwareWakingVector
,
460 (VOID
*)(UINTN
)TempStackTop
465 // 16bit Realmode waking vector
467 DEBUG (( EFI_D_ERROR
, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN
)Facs
->FirmwareWakingVector
));
468 AsmTransferControl (Facs
->FirmwareWakingVector
, 0x0);
478 Restore S3 page table because we do not trust ACPINvs content.
479 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing.
481 @param S3NvsPageTableAddress PageTableAddress in ACPINvs
484 RestoreS3PageTables (
485 IN UINTN S3NvsPageTableAddress
488 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
491 UINT8 PhysicalAddressBits
;
492 EFI_PHYSICAL_ADDRESS PageAddress
;
493 UINTN IndexOfPml4Entries
;
494 UINTN IndexOfPdpEntries
;
495 UINTN IndexOfPageDirectoryEntries
;
496 UINT32 NumberOfPml4EntriesNeeded
;
497 UINT32 NumberOfPdpEntriesNeeded
;
498 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMapLevel4Entry
;
499 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMap
;
500 PAGE_MAP_AND_DIRECTORY_POINTER
*PageDirectoryPointerEntry
;
501 PAGE_TABLE_ENTRY
*PageDirectoryEntry
;
503 BOOLEAN Page1GSupport
;
504 PAGE_TABLE_1G_ENTRY
*PageDirectory1GEntry
;
507 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.
508 // The whole page table is too large to be saved in SMRAM.
510 // The assumption is : whole page table is allocated in CONTINOUS memory and CR3 points to TOP page.
512 DEBUG ((EFI_D_ERROR
, "S3NvsPageTableAddress - %x\n", S3NvsPageTableAddress
));
515 // By architecture only one PageMapLevel4 exists - so lets allocate storgage for it.
517 PageMap
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
518 S3NvsPageTableAddress
+= SIZE_4KB
;
520 Page1GSupport
= FALSE
;
521 if (PcdGetBool(PcdUse1GPageTable
)) {
522 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
523 if (RegEax
>= 0x80000001) {
524 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
525 if ((RegEdx
& BIT26
) != 0) {
526 Page1GSupport
= TRUE
;
532 // Get physical address bits supported.
534 Hob
= GetFirstHob (EFI_HOB_TYPE_CPU
);
536 PhysicalAddressBits
= ((EFI_HOB_CPU
*) Hob
)->SizeOfMemorySpace
;
538 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
539 if (RegEax
>= 0x80000008) {
540 AsmCpuid (0x80000008, &RegEax
, NULL
, NULL
, NULL
);
541 PhysicalAddressBits
= (UINT8
) RegEax
;
543 PhysicalAddressBits
= 36;
548 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
550 ASSERT (PhysicalAddressBits
<= 52);
551 if (PhysicalAddressBits
> 48) {
552 PhysicalAddressBits
= 48;
556 // Calculate the table entries needed.
558 if (PhysicalAddressBits
<= 39) {
559 NumberOfPml4EntriesNeeded
= 1;
560 NumberOfPdpEntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 30));
562 NumberOfPml4EntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 39));
563 NumberOfPdpEntriesNeeded
= 512;
566 PageMapLevel4Entry
= PageMap
;
568 for (IndexOfPml4Entries
= 0; IndexOfPml4Entries
< NumberOfPml4EntriesNeeded
; IndexOfPml4Entries
++, PageMapLevel4Entry
++) {
570 // Each PML4 entry points to a page of Page Directory Pointer entires.
571 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.
573 PageDirectoryPointerEntry
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
574 S3NvsPageTableAddress
+= SIZE_4KB
;
579 PageMapLevel4Entry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryPointerEntry
;
580 PageMapLevel4Entry
->Bits
.ReadWrite
= 1;
581 PageMapLevel4Entry
->Bits
.Present
= 1;
584 PageDirectory1GEntry
= (VOID
*) PageDirectoryPointerEntry
;
586 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectory1GEntry
++, PageAddress
+= SIZE_1GB
) {
588 // Fill in the Page Directory entries
590 PageDirectory1GEntry
->Uint64
= (UINT64
)PageAddress
;
591 PageDirectory1GEntry
->Bits
.ReadWrite
= 1;
592 PageDirectory1GEntry
->Bits
.Present
= 1;
593 PageDirectory1GEntry
->Bits
.MustBe1
= 1;
596 for (IndexOfPdpEntries
= 0; IndexOfPdpEntries
< NumberOfPdpEntriesNeeded
; IndexOfPdpEntries
++, PageDirectoryPointerEntry
++) {
598 // Each Directory Pointer entries points to a page of Page Directory entires.
599 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.
601 PageDirectoryEntry
= (PAGE_TABLE_ENTRY
*)S3NvsPageTableAddress
;
602 S3NvsPageTableAddress
+= SIZE_4KB
;
605 // Fill in a Page Directory Pointer Entries
607 PageDirectoryPointerEntry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryEntry
;
608 PageDirectoryPointerEntry
->Bits
.ReadWrite
= 1;
609 PageDirectoryPointerEntry
->Bits
.Present
= 1;
611 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectoryEntry
++, PageAddress
+= SIZE_2MB
) {
613 // Fill in the Page Directory entries
615 PageDirectoryEntry
->Uint64
= (UINT64
)PageAddress
;
616 PageDirectoryEntry
->Bits
.ReadWrite
= 1;
617 PageDirectoryEntry
->Bits
.Present
= 1;
618 PageDirectoryEntry
->Bits
.MustBe1
= 1;
626 // If DXE is running 32-bit mode, no need to establish page table.
633 Jump to boot script executor driver.
635 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.
637 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
638 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in
639 boot script execute driver
643 S3ResumeExecuteBootScript (
644 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
645 IN BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
649 PEI_SMM_ACCESS_PPI
*SmmAccess
;
652 IA32_DESCRIPTOR
*IdtDescriptor
;
654 PEI_S3_RESUME_STATE
*PeiS3ResumeState
;
656 DEBUG ((EFI_D_ERROR
, "S3ResumeExecuteBootScript()\n"));
659 // Attempt to use content from SMRAM first
661 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
662 if (GuidHob
!= NULL
) {
664 // Last step for SMM - send SMI for initialization
670 SendSmiIpiAllExcludingSelf ();
674 SendSmiIpi (GetApicId ());
676 Status
= PeiServicesLocatePpi (
677 &gPeiSmmAccessPpiGuid
,
683 DEBUG ((EFI_D_ERROR
, "Close all SMRAM regions before executing boot script\n"));
685 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
686 Status
= SmmAccess
->Close ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
689 DEBUG ((EFI_D_ERROR
, "Lock all SMRAM regions before executing boot script\n"));
691 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
692 Status
= SmmAccess
->Lock ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
696 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
698 // Need reconstruct page table here, since we do not trust ACPINvs.
700 RestoreS3PageTables ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
);
701 AsmWriteCr3 ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
);
704 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport
)) {
706 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices
707 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)).
709 IdtDescriptor
= (IA32_DESCRIPTOR
*) (UINTN
) (AcpiS3Context
->IdtrProfile
);
711 // Make sure the newly allcated IDT align with 16-bytes
713 IdtBuffer
= AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor
->Limit
+ 1) + 16));
714 ASSERT (IdtBuffer
!= NULL
);
715 CopyMem ((VOID
*)((UINT8
*)IdtBuffer
+ 16),(VOID
*)(IdtDescriptor
->Base
), (IdtDescriptor
->Limit
+ 1));
716 IdtDescriptor
->Base
= (UINTN
)((UINT8
*)IdtBuffer
+ 16);
717 *(UINTN
*)(IdtDescriptor
->Base
- sizeof(UINTN
)) = (UINTN
)GetPeiServicesTablePointer ();
721 // Need to make sure the GDT is loaded with values that support long mode and real mode.
723 AsmWriteGdtr (&mGdt
);
726 // Prepare data for return back
728 PeiS3ResumeState
= AllocatePool (sizeof(*PeiS3ResumeState
));
729 ASSERT (PeiS3ResumeState
!= NULL
);
730 DEBUG (( EFI_D_ERROR
, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState
));
731 PeiS3ResumeState
->ReturnCs
= 0x10;
732 PeiS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeBootOs
;
733 PeiS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&Status
;
737 AsmReadIdtr (&PeiS3ResumeState
->Idtr
);
739 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
743 DEBUG (( EFI_D_ERROR
, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));
746 // Switch to long mode to complete resume.
750 EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
751 (UINT64
)(UINTN
)AcpiS3Context
,
752 (UINT64
)(UINTN
)PeiS3ResumeState
,
753 (UINT64
)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
759 DEBUG (( EFI_D_ERROR
, "transfer control to Standalone Boot Script Executor\r\n"));
761 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
762 (VOID
*)AcpiS3Context
,
763 (VOID
*)PeiS3ResumeState
,
764 (VOID
*)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
774 Restores the platform to its preboot configuration for an S3 resume and
775 jumps to the OS waking vector.
777 This function will restore the platform to its pre-boot configuration that was
778 pre-stored in the boot script table and transfer control to OS waking vector.
779 Upon invocation, this function is responsible for locating the following
780 information before jumping to OS waking vector:
783 - any other information that it needs
785 The S3RestoreConfig() function then executes the pre-stored boot script table
786 and transitions the platform to the pre-boot state. The boot script is recorded
787 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
788 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
789 transfers control to the OS waking vector. If the OS supports only a real-mode
790 waking vector, this function will switch from flat mode to real mode before
791 jumping to the waking vector. If all platform pre-boot configurations are
792 successfully restored and all other necessary information is ready, this
793 function will never return and instead will directly jump to the OS waking
794 vector. If this function returns, it indicates that the attempt to resume
795 from the ACPI S3 sleep state failed.
797 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
799 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
800 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
801 resume boot path could not be located.
807 IN EFI_PEI_S3_RESUME2_PPI
*This
811 PEI_SMM_ACCESS_PPI
*SmmAccess
;
813 ACPI_S3_CONTEXT
*AcpiS3Context
;
814 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariableServices
;
815 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable
;
816 EFI_PHYSICAL_ADDRESS TempAcpiS3Context
;
817 BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
;
819 EFI_SMRAM_DESCRIPTOR
*SmramDescriptor
;
820 SMM_S3_RESUME_STATE
*SmmS3ResumeState
;
823 DEBUG ((EFI_D_ERROR
, "Enter S3 PEIM\r\n"));
825 Status
= PeiServicesLocatePpi (
826 &gPeiSmmAccessPpiGuid
,
831 for (Index
= 0; !EFI_ERROR (Status
); Index
++) {
832 Status
= SmmAccess
->Open ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
835 Status
= PeiServicesLocatePpi (
836 &gEfiPeiReadOnlyVariable2PpiGuid
,
839 (VOID
**) &VariableServices
841 if (EFI_ERROR (Status
)) {
845 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
846 Status
= RestoreLockBox (
847 &gEfiAcpiVariableGuid
,
851 ASSERT_EFI_ERROR (Status
);
853 AcpiS3Context
= (ACPI_S3_CONTEXT
*)(UINTN
)TempAcpiS3Context
;
854 ASSERT (AcpiS3Context
!= NULL
);
856 Status
= RestoreLockBox (
857 &gEfiAcpiS3ContextGuid
,
861 ASSERT_EFI_ERROR (Status
);
863 VarSize
= sizeof (TempEfiBootScriptExecutorVariable
);
864 Status
= RestoreLockBox (
865 &gEfiBootScriptExecutorVariableGuid
,
866 &TempEfiBootScriptExecutorVariable
,
869 ASSERT_EFI_ERROR (Status
);
871 Status
= RestoreLockBox (
872 &gEfiBootScriptExecutorContextGuid
,
876 ASSERT_EFI_ERROR (Status
);
878 EfiBootScriptExecutorVariable
= (BOOT_SCRIPT_EXECUTOR_VARIABLE
*) (UINTN
) TempEfiBootScriptExecutorVariable
;
880 DEBUG (( EFI_D_ERROR
, "AcpiS3Context = %x\n", AcpiS3Context
));
881 DEBUG (( EFI_D_ERROR
, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
)))->FirmwareWakingVector
));
882 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context
->AcpiFacsTable
));
883 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context
->S3NvsPageTableAddress
));
884 DEBUG (( EFI_D_ERROR
, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context
->S3DebugBufferAddress
));
885 DEBUG (( EFI_D_ERROR
, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
));
888 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.
889 // Script dispatch image and context (parameter) are handled by platform.
890 // We just use restore all lock box in place, no need restore one by one.
892 Status
= RestoreAllLockBoxInPlace ();
893 ASSERT_EFI_ERROR (Status
);
894 if (EFI_ERROR (Status
)) {
900 // Attempt to use content from SMRAM first
902 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
903 if (GuidHob
!= NULL
) {
904 SmramDescriptor
= (EFI_SMRAM_DESCRIPTOR
*) GET_GUID_HOB_DATA (GuidHob
);
905 SmmS3ResumeState
= (SMM_S3_RESUME_STATE
*)(UINTN
)SmramDescriptor
->CpuStart
;
907 SmmS3ResumeState
->ReturnCs
= AsmReadCs ();
908 SmmS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeExecuteBootScript
;
909 SmmS3ResumeState
->ReturnContext1
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AcpiS3Context
;
910 SmmS3ResumeState
->ReturnContext2
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)EfiBootScriptExecutorVariable
;
911 SmmS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&Status
;
913 DEBUG (( EFI_D_ERROR
, "SMM S3 Signature = %x\n", SmmS3ResumeState
->Signature
));
914 DEBUG (( EFI_D_ERROR
, "SMM S3 Stack Base = %x\n", SmmS3ResumeState
->SmmS3StackBase
));
915 DEBUG (( EFI_D_ERROR
, "SMM S3 Stack Size = %x\n", SmmS3ResumeState
->SmmS3StackSize
));
916 DEBUG (( EFI_D_ERROR
, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState
->SmmS3ResumeEntryPoint
));
917 DEBUG (( EFI_D_ERROR
, "SMM S3 CR0 = %x\n", SmmS3ResumeState
->SmmS3Cr0
));
918 DEBUG (( EFI_D_ERROR
, "SMM S3 CR3 = %x\n", SmmS3ResumeState
->SmmS3Cr3
));
919 DEBUG (( EFI_D_ERROR
, "SMM S3 CR4 = %x\n", SmmS3ResumeState
->SmmS3Cr4
));
920 DEBUG (( EFI_D_ERROR
, "SMM S3 Return CS = %x\n", SmmS3ResumeState
->ReturnCs
));
921 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState
->ReturnEntryPoint
));
922 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState
->ReturnContext1
));
923 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState
->ReturnContext2
));
924 DEBUG (( EFI_D_ERROR
, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState
->ReturnStackPointer
));
925 DEBUG (( EFI_D_ERROR
, "SMM S3 Smst = %x\n", SmmS3ResumeState
->Smst
));
928 // Disable interrupt of Debug timer.
930 SaveAndSetDebugTimerInterrupt (FALSE
);
932 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_32
) {
934 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
935 (VOID
*)AcpiS3Context
,
937 (VOID
*)(UINTN
)(SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
)
940 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_64
) {
942 // Switch to long mode to complete resume.
946 // Need to make sure the GDT is loaded with values that support long mode and real mode.
948 AsmWriteGdtr (&mGdt
);
949 AsmWriteCr3 ((UINTN
)SmmS3ResumeState
->SmmS3Cr3
);
952 SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
953 (UINT64
)(UINTN
)AcpiS3Context
,
955 SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
961 S3ResumeExecuteBootScript (AcpiS3Context
, EfiBootScriptExecutorVariable
);
965 Main entry for S3 Resume PEIM.
967 This routine is to install EFI_PEI_S3_RESUME2_PPI.
969 @param FileHandle Handle of the file being invoked.
970 @param PeiServices Pointer to PEI Services table.
972 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.
977 PeimS3ResumeEntryPoint (
978 IN EFI_PEI_FILE_HANDLE FileHandle
,
979 IN CONST EFI_PEI_SERVICES
**PeiServices
985 // Install S3 Resume Ppi
987 Status
= (**PeiServices
).InstallPpi (PeiServices
, &mPpiList
);
988 ASSERT_EFI_ERROR (Status
);