2 This is the code for Boot Script Executer module.
4 This driver is dispatched by Dxe core and the driver will reload itself to ACPI NVS memory
5 in the entry point. The functionality is to interpret and restore the S3 boot script
7 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include "ScriptExecute.h"
21 EFI_GUID mBootScriptExecutorImageGuid
= {
22 0x9a8d3433, 0x9fe8, 0x42b6, { 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b }
26 Entry function of Boot script exector. This function will be executed in
28 This function should not return, because it is invoked by switch stack.
30 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
31 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
33 @retval EFI_INVALID_PARAMETER - OS waking vector not found
34 @retval EFI_UNSUPPORTED - something wrong when we resume to OS
38 S3BootScriptExecutorEntryFunction (
39 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
40 IN PEI_S3_RESUME_STATE
*PeiS3ResumeState
43 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
46 UINTN TempStack
[0x10];
47 UINTN AsmTransferControl16Address
;
48 IA32_DESCRIPTOR IdtDescriptor
;
51 // Disable interrupt of Debug timer, since new IDT table cannot handle it.
53 SaveAndSetDebugTimerInterrupt (FALSE
);
55 AsmReadIdtr (&IdtDescriptor
);
57 // Restore IDT for debug
59 SetIdtEntry (AcpiS3Context
);
62 // Initialize Debug Agent to support source level debug in S3 path, it will disable interrupt and Debug Timer.
64 InitializeDebugAgent (DEBUG_AGENT_INIT_S3
, (VOID
*)&IdtDescriptor
, NULL
);
67 // Because not install BootScriptExecute PPI(used just in this module), So just pass NULL
68 // for that parameter.
70 Status
= S3BootScriptExecute ();
75 // Get ACPI Table Address
77 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
80 // We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.
82 if (PeiS3ResumeState
!= 0) {
84 // Need report status back to S3ResumePeim.
85 // If boot script execution is failed, S3ResumePeim wil report the error status code.
87 PeiS3ResumeState
->ReturnStatus
= (UINT64
)(UINTN
)Status
;
88 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
92 DEBUG ((EFI_D_ERROR
, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));
93 PeiS3ResumeState
->AsmTransferControl
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AsmTransferControl32
;
96 (Facs
->Signature
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) &&
97 (Facs
->FirmwareWakingVector
!= 0) ) {
99 // more step needed - because relative address is handled differently between X64 and IA32.
101 AsmTransferControl16Address
= (UINTN
)AsmTransferControl16
;
102 AsmFixAddress16
= (UINT32
)AsmTransferControl16Address
;
103 AsmJmpAddr32
= (UINT32
)((Facs
->FirmwareWakingVector
& 0xF) | ((Facs
->FirmwareWakingVector
& 0xFFFF0) << 12));
107 PeiS3ResumeState
->ReturnCs
,
108 (UINT32
)PeiS3ResumeState
->ReturnEntryPoint
,
109 (UINT32
)(UINTN
)AcpiS3Context
,
110 (UINT32
)(UINTN
)PeiS3ResumeState
,
111 (UINT32
)PeiS3ResumeState
->ReturnStackPointer
117 DEBUG ((EFI_D_ERROR
, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));
118 PeiS3ResumeState
->AsmTransferControl
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AsmTransferControl
;
121 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)PeiS3ResumeState
->ReturnEntryPoint
,
122 (VOID
*)(UINTN
)AcpiS3Context
,
123 (VOID
*)(UINTN
)PeiS3ResumeState
,
124 (VOID
*)(UINTN
)PeiS3ResumeState
->ReturnStackPointer
132 return EFI_UNSUPPORTED
;
136 // S3ResumePeim does not provide a way to jump back to itself, so resume to OS here directly
138 if (Facs
->XFirmwareWakingVector
!= 0) {
140 // Switch to native waking vector
142 TempStackTop
= (UINTN
)&TempStack
+ sizeof(TempStack
);
143 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
144 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
145 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
147 // X64 long mode waking vector
149 DEBUG (( EFI_D_ERROR
, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
150 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
152 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)Facs
->XFirmwareWakingVector
,
155 (VOID
*)(UINTN
)TempStackTop
158 // Unsupported for 32bit DXE, 64bit OS vector
159 DEBUG (( EFI_D_ERROR
, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
164 // IA32 protected mode waking vector (Page disabled)
166 DEBUG (( EFI_D_ERROR
, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
167 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
170 (UINT32
)Facs
->XFirmwareWakingVector
,
177 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)Facs
->XFirmwareWakingVector
,
180 (VOID
*)(UINTN
)TempStackTop
186 // 16bit Realmode waking vector
188 DEBUG (( EFI_D_ERROR
, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN
)Facs
->FirmwareWakingVector
));
189 AsmTransferControl (Facs
->FirmwareWakingVector
, 0x0);
196 return EFI_UNSUPPORTED
;
199 Entrypoint of Boot script exector driver, this function will be executed in
200 normal boot phase and invoked by DXE dispatch.
202 @param[in] ImageHandle The firmware allocated handle for the EFI image.
203 @param[in] SystemTable A pointer to the EFI System Table.
205 @retval EFI_SUCCESS The entry point is executed successfully.
206 @retval other Some error occurs when executing this entry point.
210 BootScriptExecutorEntryPoint (
211 IN EFI_HANDLE ImageHandle
,
212 IN EFI_SYSTEM_TABLE
*SystemTable
218 EFI_PHYSICAL_ADDRESS FfsBuffer
;
219 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
220 BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
;
221 EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer
;
224 EFI_HANDLE NewImageHandle
;
227 // Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry
228 // point is loaded by DXE code which is the first time loaded. or else, it is already
229 // be reloaded be itself.This is a work-around
231 Status
= gBS
->LocateProtocol (&gEfiCallerIdGuid
, NULL
, &DevicePath
);
232 if (EFI_ERROR (Status
)) {
235 // This is the first-time loaded by DXE core. reload itself to NVS mem
238 // A workarouond: Here we install a dummy handle
240 NewImageHandle
= NULL
;
241 Status
= gBS
->InstallProtocolInterface (
244 EFI_NATIVE_INTERFACE
,
248 Status
= GetSectionFromAnyFv (
255 ImageContext
.Handle
= Buffer
;
256 ImageContext
.ImageRead
= PeCoffLoaderImageReadFromMemory
;
258 // Get information about the image being loaded
260 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
261 if (EFI_ERROR (Status
)) {
264 Pages
= EFI_SIZE_TO_PAGES(BufferSize
+ ImageContext
.SectionAlignment
);
265 FfsBuffer
= 0xFFFFFFFF;
266 Status
= gBS
->AllocatePages (
272 if (EFI_ERROR (Status
)) {
273 return EFI_OUT_OF_RESOURCES
;
275 ImageContext
.ImageAddress
= (PHYSICAL_ADDRESS
)(UINTN
)FfsBuffer
;
277 // Align buffer on section boundry
279 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
- 1;
280 ImageContext
.ImageAddress
&= ~(ImageContext
.SectionAlignment
- 1);
282 // Load the image to our new buffer
284 Status
= PeCoffLoaderLoadImage (&ImageContext
);
285 if (EFI_ERROR (Status
)) {
286 gBS
->FreePages (FfsBuffer
, Pages
);
291 // Relocate the image in our new buffer
293 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
295 if (EFI_ERROR (Status
)) {
296 PeCoffLoaderUnloadImage (&ImageContext
);
297 gBS
->FreePages (FfsBuffer
, Pages
);
301 // Flush the instruction cache so the image data is written before we execute it
303 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)ImageContext
.ImageAddress
, (UINTN
)ImageContext
.ImageSize
);
304 Status
= ((EFI_IMAGE_ENTRY_POINT
)(UINTN
)(ImageContext
.EntryPoint
)) (NewImageHandle
, SystemTable
);
305 if (EFI_ERROR (Status
)) {
306 gBS
->FreePages (FfsBuffer
, Pages
);
310 // Additional step for BootScript integrity
311 // Save BootScriptExecutor image
313 Status
= SaveLockBox (
314 &mBootScriptExecutorImageGuid
,
315 (VOID
*)(UINTN
)ImageContext
.ImageAddress
,
316 (UINTN
)ImageContext
.ImageSize
318 ASSERT_EFI_ERROR (Status
);
320 Status
= SetLockBoxAttributes (&mBootScriptExecutorImageGuid
, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE
);
321 ASSERT_EFI_ERROR (Status
);
325 // the entry point is invoked after reloading. following code only run in ACPI NVS
327 BufferSize
= sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE
);
329 BootScriptExecutorBuffer
= 0xFFFFFFFF;
330 Pages
= EFI_SIZE_TO_PAGES(BufferSize
);
331 Status
= gBS
->AllocatePages (
335 &BootScriptExecutorBuffer
337 if (EFI_ERROR (Status
)) {
338 return EFI_OUT_OF_RESOURCES
;
341 EfiBootScriptExecutorVariable
= (BOOT_SCRIPT_EXECUTOR_VARIABLE
*)(UINTN
)BootScriptExecutorBuffer
;
342 EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
= (UINTN
) S3BootScriptExecutorEntryFunction
;
344 Status
= SaveLockBox (
345 &gEfiBootScriptExecutorVariableGuid
,
346 &BootScriptExecutorBuffer
,
347 sizeof(BootScriptExecutorBuffer
)
349 ASSERT_EFI_ERROR (Status
);
352 // Additional step for BootScript integrity
353 // Save BootScriptExecutor context
355 Status
= SaveLockBox (
356 &gEfiBootScriptExecutorContextGuid
,
357 EfiBootScriptExecutorVariable
,
358 sizeof(*EfiBootScriptExecutorVariable
)
360 ASSERT_EFI_ERROR (Status
);
362 Status
= SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid
, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE
);
363 ASSERT_EFI_ERROR (Status
);