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 reserved memory
5 in the entry point. The functionality is to interpret and restore the S3 boot script
7 Copyright (c) 2006 - 2015, 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 }
25 BOOLEAN mPage1GSupport
= FALSE
;
28 Entry function of Boot script exector. This function will be executed in
30 This function should not return, because it is invoked by switch stack.
32 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
33 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
35 @retval EFI_INVALID_PARAMETER - OS waking vector not found
36 @retval EFI_UNSUPPORTED - something wrong when we resume to OS
40 S3BootScriptExecutorEntryFunction (
41 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
42 IN PEI_S3_RESUME_STATE
*PeiS3ResumeState
45 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
48 UINTN TempStack
[0x10];
49 UINTN AsmTransferControl16Address
;
50 IA32_DESCRIPTOR IdtDescriptor
;
53 // Disable interrupt of Debug timer, since new IDT table cannot handle it.
55 SaveAndSetDebugTimerInterrupt (FALSE
);
57 AsmReadIdtr (&IdtDescriptor
);
59 // Restore IDT for debug
61 SetIdtEntry (AcpiS3Context
);
64 // Initialize Debug Agent to support source level debug in S3 path, it will disable interrupt and Debug Timer.
66 InitializeDebugAgent (DEBUG_AGENT_INIT_S3
, (VOID
*)&IdtDescriptor
, NULL
);
69 // Because not install BootScriptExecute PPI(used just in this module), So just pass NULL
70 // for that parameter.
72 Status
= S3BootScriptExecute ();
75 // If invalid script table or opcode in S3 boot script table.
77 ASSERT_EFI_ERROR (Status
);
79 if (EFI_ERROR (Status
)) {
87 // Get ACPI Table Address
89 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
92 // We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.
94 if (PeiS3ResumeState
!= 0) {
96 // Need report status back to S3ResumePeim.
97 // If boot script execution is failed, S3ResumePeim wil report the error status code.
99 PeiS3ResumeState
->ReturnStatus
= (UINT64
)(UINTN
)Status
;
100 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
104 DEBUG ((EFI_D_ERROR
, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));
105 PeiS3ResumeState
->AsmTransferControl
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AsmTransferControl32
;
107 if ((Facs
!= NULL
) &&
108 (Facs
->Signature
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) &&
109 (Facs
->FirmwareWakingVector
!= 0) ) {
111 // more step needed - because relative address is handled differently between X64 and IA32.
113 AsmTransferControl16Address
= (UINTN
)AsmTransferControl16
;
114 AsmFixAddress16
= (UINT32
)AsmTransferControl16Address
;
115 AsmJmpAddr32
= (UINT32
)((Facs
->FirmwareWakingVector
& 0xF) | ((Facs
->FirmwareWakingVector
& 0xFFFF0) << 12));
119 PeiS3ResumeState
->ReturnCs
,
120 (UINT32
)PeiS3ResumeState
->ReturnEntryPoint
,
121 (UINT32
)(UINTN
)AcpiS3Context
,
122 (UINT32
)(UINTN
)PeiS3ResumeState
,
123 (UINT32
)PeiS3ResumeState
->ReturnStackPointer
129 DEBUG ((EFI_D_ERROR
, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));
130 PeiS3ResumeState
->AsmTransferControl
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AsmTransferControl
;
133 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)PeiS3ResumeState
->ReturnEntryPoint
,
134 (VOID
*)(UINTN
)AcpiS3Context
,
135 (VOID
*)(UINTN
)PeiS3ResumeState
,
136 (VOID
*)(UINTN
)PeiS3ResumeState
->ReturnStackPointer
144 return EFI_UNSUPPORTED
;
148 // S3ResumePeim does not provide a way to jump back to itself, so resume to OS here directly
150 if (Facs
->XFirmwareWakingVector
!= 0) {
152 // Switch to native waking vector
154 TempStackTop
= (UINTN
)&TempStack
+ sizeof(TempStack
);
155 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
156 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
157 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
159 // X64 long mode waking vector
161 DEBUG (( EFI_D_ERROR
, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
162 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
164 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)Facs
->XFirmwareWakingVector
,
167 (VOID
*)(UINTN
)TempStackTop
170 // Unsupported for 32bit DXE, 64bit OS vector
171 DEBUG (( EFI_D_ERROR
, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
176 // IA32 protected mode waking vector (Page disabled)
178 DEBUG (( EFI_D_ERROR
, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
179 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
182 (UINT32
)Facs
->XFirmwareWakingVector
,
189 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)Facs
->XFirmwareWakingVector
,
192 (VOID
*)(UINTN
)TempStackTop
198 // 16bit Realmode waking vector
200 DEBUG (( EFI_D_ERROR
, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN
)Facs
->FirmwareWakingVector
));
201 AsmTransferControl (Facs
->FirmwareWakingVector
, 0x0);
208 return EFI_UNSUPPORTED
;
212 Register image to memory profile.
214 @param FileName File name of the image.
215 @param ImageBase Image base address.
216 @param ImageSize Image size.
217 @param FileType File type of the image.
221 RegisterMemoryProfileImage (
222 IN EFI_GUID
*FileName
,
223 IN PHYSICAL_ADDRESS ImageBase
,
225 IN EFI_FV_FILETYPE FileType
229 EDKII_MEMORY_PROFILE_PROTOCOL
*ProfileProtocol
;
230 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*FilePath
;
231 UINT8 TempBuffer
[sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
) + sizeof (EFI_DEVICE_PATH_PROTOCOL
)];
233 if ((PcdGet8 (PcdMemoryProfilePropertyMask
) & BIT0
) != 0) {
235 FilePath
= (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*)TempBuffer
;
236 Status
= gBS
->LocateProtocol (&gEdkiiMemoryProfileGuid
, NULL
, (VOID
**) &ProfileProtocol
);
237 if (!EFI_ERROR (Status
)) {
238 EfiInitializeFwVolDevicepathNode (FilePath
, FileName
);
239 SetDevicePathEndNode (FilePath
+ 1);
241 Status
= ProfileProtocol
->RegisterImage (
243 (EFI_DEVICE_PATH_PROTOCOL
*) FilePath
,
253 This is the Event notification function to reload BootScriptExecutor image
254 to RESERVED mem and save it to LockBox.
256 @param Event Pointer to this event
257 @param Context Event handler private data
261 ReadyToLockEventNotify (
270 EFI_HANDLE NewImageHandle
;
272 EFI_PHYSICAL_ADDRESS FfsBuffer
;
273 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
275 Status
= gBS
->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid
, NULL
, &Interface
);
276 if (EFI_ERROR (Status
)) {
281 // A workaround: Here we install a dummy handle
283 NewImageHandle
= NULL
;
284 Status
= gBS
->InstallProtocolInterface (
287 EFI_NATIVE_INTERFACE
,
290 ASSERT_EFI_ERROR (Status
);
293 // Reload BootScriptExecutor image itself to RESERVED mem
295 Status
= GetSectionFromAnyFv (
302 ASSERT_EFI_ERROR (Status
);
303 ImageContext
.Handle
= Buffer
;
304 ImageContext
.ImageRead
= PeCoffLoaderImageReadFromMemory
;
306 // Get information about the image being loaded
308 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
309 ASSERT_EFI_ERROR (Status
);
310 if (ImageContext
.SectionAlignment
> EFI_PAGE_SIZE
) {
311 Pages
= EFI_SIZE_TO_PAGES (ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
313 Pages
= EFI_SIZE_TO_PAGES (ImageContext
.ImageSize
);
315 FfsBuffer
= 0xFFFFFFFF;
316 Status
= gBS
->AllocatePages (
318 EfiReservedMemoryType
,
322 ASSERT_EFI_ERROR (Status
);
323 ImageContext
.ImageAddress
= (PHYSICAL_ADDRESS
)(UINTN
)FfsBuffer
;
325 // Align buffer on section boundry
327 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
- 1;
328 ImageContext
.ImageAddress
&= ~((EFI_PHYSICAL_ADDRESS
)(ImageContext
.SectionAlignment
- 1));
330 // Load the image to our new buffer
332 Status
= PeCoffLoaderLoadImage (&ImageContext
);
333 ASSERT_EFI_ERROR (Status
);
336 // Relocate the image in our new buffer
338 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
339 ASSERT_EFI_ERROR (Status
);
342 // Free the buffer allocated by ReadSection since the image has been relocated in the new buffer
344 gBS
->FreePool (Buffer
);
347 // Flush the instruction cache so the image data is written before we execute it
349 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)ImageContext
.ImageAddress
, (UINTN
)ImageContext
.ImageSize
);
351 RegisterMemoryProfileImage (
353 ImageContext
.ImageAddress
,
354 ImageContext
.ImageSize
,
355 EFI_FV_FILETYPE_DRIVER
358 Status
= ((EFI_IMAGE_ENTRY_POINT
)(UINTN
)(ImageContext
.EntryPoint
)) (NewImageHandle
, gST
);
359 ASSERT_EFI_ERROR (Status
);
362 // Additional step for BootScript integrity
363 // Save BootScriptExecutor image
365 Status
= SaveLockBox (
366 &mBootScriptExecutorImageGuid
,
367 (VOID
*)(UINTN
)ImageContext
.ImageAddress
,
368 (UINTN
)ImageContext
.ImageSize
370 ASSERT_EFI_ERROR (Status
);
372 Status
= SetLockBoxAttributes (&mBootScriptExecutorImageGuid
, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE
);
373 ASSERT_EFI_ERROR (Status
);
375 gBS
->CloseEvent (Event
);
379 Entrypoint of Boot script exector driver, this function will be executed in
380 normal boot phase and invoked by DXE dispatch.
382 @param[in] ImageHandle The firmware allocated handle for the EFI image.
383 @param[in] SystemTable A pointer to the EFI System Table.
385 @retval EFI_SUCCESS The entry point is executed successfully.
386 @retval other Some error occurs when executing this entry point.
390 BootScriptExecutorEntryPoint (
391 IN EFI_HANDLE ImageHandle
,
392 IN EFI_SYSTEM_TABLE
*SystemTable
397 BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
;
398 EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer
;
401 EFI_EVENT ReadyToLockEvent
;
407 // Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry
408 // point is loaded by DXE code which is the first time loaded. or else, it is already
409 // be reloaded be itself.This is a work-around
411 Status
= gBS
->LocateProtocol (&gEfiCallerIdGuid
, NULL
, &DevicePath
);
412 if (EFI_ERROR (Status
)) {
414 // Create ReadyToLock event to reload BootScriptExecutor image
415 // to RESERVED mem and save it to LockBox.
417 ReadyToLockEvent
= EfiCreateProtocolNotifyEvent (
418 &gEfiDxeSmmReadyToLockProtocolGuid
,
420 ReadyToLockEventNotify
,
424 ASSERT (ReadyToLockEvent
!= NULL
);
427 // the entry point is invoked after reloading. following code only run in RESERVED mem
429 if (PcdGetBool(PcdUse1GPageTable
)) {
430 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
431 if (RegEax
>= 0x80000001) {
432 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
433 if ((RegEdx
& BIT26
) != 0) {
434 mPage1GSupport
= TRUE
;
439 BufferSize
= sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE
);
441 BootScriptExecutorBuffer
= 0xFFFFFFFF;
442 Pages
= EFI_SIZE_TO_PAGES(BufferSize
);
443 Status
= gBS
->AllocatePages (
445 EfiReservedMemoryType
,
447 &BootScriptExecutorBuffer
449 ASSERT_EFI_ERROR (Status
);
451 EfiBootScriptExecutorVariable
= (BOOT_SCRIPT_EXECUTOR_VARIABLE
*)(UINTN
)BootScriptExecutorBuffer
;
452 EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
= (UINTN
) S3BootScriptExecutorEntryFunction
;
454 Status
= SaveLockBox (
455 &gEfiBootScriptExecutorVariableGuid
,
456 &BootScriptExecutorBuffer
,
457 sizeof(BootScriptExecutorBuffer
)
459 ASSERT_EFI_ERROR (Status
);
462 // Additional step for BootScript integrity
463 // Save BootScriptExecutor context
465 Status
= SaveLockBox (
466 &gEfiBootScriptExecutorContextGuid
,
467 EfiBootScriptExecutorVariable
,
468 sizeof(*EfiBootScriptExecutorVariable
)
470 ASSERT_EFI_ERROR (Status
);
472 Status
= SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid
, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE
);
473 ASSERT_EFI_ERROR (Status
);