This driver is dispatched by Dxe core and the driver will reload itself to ACPI reserved memory\r
in the entry point. The functionality is to interpret and restore the S3 boot script\r
\r
-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "ScriptExecute.h"\r
\r
-EFI_GUID mBootScriptExecutorImageGuid = {\r
+EFI_GUID mBootScriptExecutorImageGuid = {\r
0x9a8d3433, 0x9fe8, 0x42b6, { 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b }\r
};\r
\r
-BOOLEAN mPage1GSupport = FALSE;\r
+BOOLEAN mPage1GSupport = FALSE;\r
+UINT64 mAddressEncMask = 0;\r
\r
/**\r
Entry function of Boot script exector. This function will be executed in\r
EFI_STATUS\r
EFIAPI\r
S3BootScriptExecutorEntryFunction (\r
- IN ACPI_S3_CONTEXT *AcpiS3Context,\r
- IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
+ IN ACPI_S3_CONTEXT *AcpiS3Context,\r
+ IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
)\r
{\r
EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
// for that parameter.\r
//\r
Status = S3BootScriptExecute ();\r
- \r
+\r
//\r
// If invalid script table or opcode in S3 boot script table.\r
//\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
if (EFI_ERROR (Status)) {\r
CpuDeadLoop ();\r
return Status;\r
//\r
// Get ACPI Table Address\r
//\r
- Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
+ Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *)((UINTN)(AcpiS3Context->AcpiFacsTable));\r
\r
//\r
// We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.\r
//\r
if (PeiS3ResumeState != 0) {\r
//\r
- // Need report status back to S3ResumePeim. \r
+ // Need report status back to S3ResumePeim.\r
// If boot script execution is failed, S3ResumePeim wil report the error status code.\r
//\r
PeiS3ResumeState->ReturnStatus = (UINT64)(UINTN)Status;\r
//\r
// X64 S3 Resume\r
//\r
- DEBUG ((EFI_D_ERROR, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));\r
+ DEBUG ((DEBUG_INFO, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));\r
PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl32;\r
\r
if ((Facs != NULL) &&\r
(Facs->Signature == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) &&\r
- (Facs->FirmwareWakingVector != 0) ) {\r
+ (Facs->FirmwareWakingVector != 0))\r
+ {\r
//\r
// more step needed - because relative address is handled differently between X64 and IA32.\r
//\r
AsmTransferControl16Address = (UINTN)AsmTransferControl16;\r
- AsmFixAddress16 = (UINT32)AsmTransferControl16Address;\r
- AsmJmpAddr32 = (UINT32)((Facs->FirmwareWakingVector & 0xF) | ((Facs->FirmwareWakingVector & 0xFFFF0) << 12));\r
+ AsmFixAddress16 = (UINT32)AsmTransferControl16Address;\r
+ AsmJmpAddr32 = (UINT32)((Facs->FirmwareWakingVector & 0xF) | ((Facs->FirmwareWakingVector & 0xFFFF0) << 12));\r
}\r
\r
AsmDisablePaging64 (\r
//\r
// IA32 S3 Resume\r
//\r
- DEBUG ((EFI_D_ERROR, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
+ DEBUG ((DEBUG_INFO, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl;\r
\r
SwitchStack (\r
//\r
// Never run to here\r
//\r
- CpuDeadLoop();\r
+ CpuDeadLoop ();\r
return EFI_UNSUPPORTED;\r
}\r
- \r
+\r
//\r
// S3ResumePeim does not provide a way to jump back to itself, so resume to OS here directly\r
//\r
//\r
// Switch to native waking vector\r
//\r
- TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
+ TempStackTop = (UINTN)&TempStack + sizeof (TempStack);\r
if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
- ((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
+ ((Facs->OspmFlags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0))\r
+ {\r
//\r
// X64 long mode waking vector\r
//\r
- DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
+ DEBUG ((DEBUG_INFO, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
SwitchStack (\r
(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
);\r
} else {\r
// Unsupported for 32bit DXE, 64bit OS vector\r
- DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
+ DEBUG ((DEBUG_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
ASSERT (FALSE);\r
}\r
} else {\r
//\r
// IA32 protected mode waking vector (Page disabled)\r
//\r
- DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
+ DEBUG ((DEBUG_INFO, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
AsmDisablePaging64 (\r
0x10,\r
//\r
// 16bit Realmode waking vector\r
//\r
- DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
+ DEBUG ((DEBUG_INFO, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
}\r
\r
//\r
// Never run to here\r
//\r
- CpuDeadLoop();\r
+ CpuDeadLoop ();\r
return EFI_UNSUPPORTED;\r
}\r
\r
**/\r
VOID\r
RegisterMemoryProfileImage (\r
- IN EFI_GUID *FileName,\r
- IN PHYSICAL_ADDRESS ImageBase,\r
- IN UINT64 ImageSize,\r
- IN EFI_FV_FILETYPE FileType\r
+ IN EFI_GUID *FileName,\r
+ IN PHYSICAL_ADDRESS ImageBase,\r
+ IN UINT64 ImageSize,\r
+ IN EFI_FV_FILETYPE FileType\r
)\r
{\r
- EFI_STATUS Status;\r
- EDKII_MEMORY_PROFILE_PROTOCOL *ProfileProtocol;\r
- MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FilePath;\r
- UINT8 TempBuffer[sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH) + sizeof (EFI_DEVICE_PATH_PROTOCOL)];\r
+ EFI_STATUS Status;\r
+ EDKII_MEMORY_PROFILE_PROTOCOL *ProfileProtocol;\r
+ MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FilePath;\r
+ UINT8 TempBuffer[sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH) + sizeof (EFI_DEVICE_PATH_PROTOCOL)];\r
\r
if ((PcdGet8 (PcdMemoryProfilePropertyMask) & BIT0) != 0) {\r
-\r
FilePath = (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)TempBuffer;\r
- Status = gBS->LocateProtocol (&gEdkiiMemoryProfileGuid, NULL, (VOID **) &ProfileProtocol);\r
+ Status = gBS->LocateProtocol (&gEdkiiMemoryProfileGuid, NULL, (VOID **)&ProfileProtocol);\r
if (!EFI_ERROR (Status)) {\r
EfiInitializeFwVolDevicepathNode (FilePath, FileName);\r
SetDevicePathEndNode (FilePath + 1);\r
\r
Status = ProfileProtocol->RegisterImage (\r
ProfileProtocol,\r
- (EFI_DEVICE_PATH_PROTOCOL *) FilePath,\r
+ (EFI_DEVICE_PATH_PROTOCOL *)FilePath,\r
ImageBase,\r
ImageSize,\r
FileType\r
/**\r
This is the Event notification function to reload BootScriptExecutor image\r
to RESERVED mem and save it to LockBox.\r
- \r
+\r
@param Event Pointer to this event\r
- @param Context Event handler private data \r
+ @param Context Event handler private data\r
**/\r
VOID\r
EFIAPI\r
IN VOID *Context\r
)\r
{\r
- EFI_STATUS Status;\r
- VOID *Interface;\r
- UINT8 *Buffer;\r
- UINTN BufferSize;\r
- EFI_HANDLE NewImageHandle;\r
- UINTN Pages;\r
- EFI_PHYSICAL_ADDRESS FfsBuffer;\r
- PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
+ EFI_STATUS Status;\r
+ VOID *Interface;\r
+ UINT8 *Buffer;\r
+ UINTN BufferSize;\r
+ EFI_HANDLE NewImageHandle;\r
+ UINTN Pages;\r
+ EFI_PHYSICAL_ADDRESS FfsBuffer;\r
+ PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
+ EFI_GCD_MEMORY_SPACE_DESCRIPTOR MemDesc;\r
\r
Status = gBS->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid, NULL, &Interface);\r
if (EFI_ERROR (Status)) {\r
// A workaround: Here we install a dummy handle\r
//\r
NewImageHandle = NULL;\r
- Status = gBS->InstallProtocolInterface (\r
- &NewImageHandle,\r
- &gEfiCallerIdGuid,\r
- EFI_NATIVE_INTERFACE,\r
- NULL\r
- );\r
+ Status = gBS->InstallProtocolInterface (\r
+ &NewImageHandle,\r
+ &gEfiCallerIdGuid,\r
+ EFI_NATIVE_INTERFACE,\r
+ NULL\r
+ );\r
ASSERT_EFI_ERROR (Status);\r
\r
//\r
// Reload BootScriptExecutor image itself to RESERVED mem\r
//\r
- Status = GetSectionFromAnyFv (\r
+ Status = GetSectionFromAnyFv (\r
&gEfiCallerIdGuid,\r
EFI_SECTION_PE32,\r
0,\r
- (VOID **) &Buffer,\r
+ (VOID **)&Buffer,\r
&BufferSize\r
);\r
ASSERT_EFI_ERROR (Status);\r
Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
ASSERT_EFI_ERROR (Status);\r
if (ImageContext.SectionAlignment > EFI_PAGE_SIZE) {\r
- Pages = EFI_SIZE_TO_PAGES ((UINTN) (ImageContext.ImageSize + ImageContext.SectionAlignment));\r
+ Pages = EFI_SIZE_TO_PAGES ((UINTN)(ImageContext.ImageSize + ImageContext.SectionAlignment));\r
} else {\r
- Pages = EFI_SIZE_TO_PAGES ((UINTN) ImageContext.ImageSize);\r
+ Pages = EFI_SIZE_TO_PAGES ((UINTN)ImageContext.ImageSize);\r
}\r
+\r
FfsBuffer = 0xFFFFFFFF;\r
- Status = gBS->AllocatePages (\r
- AllocateMaxAddress,\r
- EfiReservedMemoryType,\r
- Pages,\r
- &FfsBuffer\r
- );\r
+ Status = gBS->AllocatePages (\r
+ AllocateMaxAddress,\r
+ EfiReservedMemoryType,\r
+ Pages,\r
+ &FfsBuffer\r
+ );\r
ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Make sure that the buffer can be used to store code.\r
+ //\r
+ Status = gDS->GetMemorySpaceDescriptor (FfsBuffer, &MemDesc);\r
+ if (!EFI_ERROR (Status) && ((MemDesc.Attributes & EFI_MEMORY_XP) != 0)) {\r
+ gDS->SetMemorySpaceAttributes (\r
+ FfsBuffer,\r
+ EFI_PAGES_TO_SIZE (Pages),\r
+ MemDesc.Attributes & (~EFI_MEMORY_XP)\r
+ );\r
+ }\r
+\r
ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
//\r
- // Align buffer on section boundry\r
+ // Align buffer on section boundary\r
//\r
ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
- ImageContext.ImageAddress &= ~((EFI_PHYSICAL_ADDRESS)(ImageContext.SectionAlignment - 1));\r
+ ImageContext.ImageAddress &= ~((EFI_PHYSICAL_ADDRESS)ImageContext.SectionAlignment - 1);\r
//\r
// Load the image to our new buffer\r
//\r
EFI_FV_FILETYPE_DRIVER\r
);\r
\r
- Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint)) (NewImageHandle, gST);\r
+ Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint))(NewImageHandle, gST);\r
ASSERT_EFI_ERROR (Status);\r
\r
//\r
EFI_STATUS\r
EFIAPI\r
BootScriptExecutorEntryPoint (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
{\r
- UINTN BufferSize;\r
- UINTN Pages;\r
- BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
- EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer;\r
- EFI_STATUS Status;\r
- VOID *DevicePath;\r
- EFI_EVENT ReadyToLockEvent;\r
- VOID *Registration;\r
- UINT32 RegEax;\r
- UINT32 RegEdx;\r
+ UINTN BufferSize;\r
+ UINTN Pages;\r
+ BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
+ EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer;\r
+ EFI_STATUS Status;\r
+ VOID *DevicePath;\r
+ EFI_EVENT ReadyToLockEvent;\r
+ VOID *Registration;\r
+ UINT32 RegEax;\r
+ UINT32 RegEdx;\r
+\r
+ if (!PcdGetBool (PcdAcpiS3Enable)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Make sure AddressEncMask is contained to smallest supported address field.\r
+ //\r
+ mAddressEncMask = PcdGet64 (PcdPteMemoryEncryptionAddressOrMask) & PAGING_1G_ADDRESS_MASK_64;\r
\r
//\r
// Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry\r
//\r
Status = gBS->LocateProtocol (&gEfiCallerIdGuid, NULL, &DevicePath);\r
if (EFI_ERROR (Status)) {\r
- //\r
- // Create ReadyToLock event to reload BootScriptExecutor image\r
- // to RESERVED mem and save it to LockBox.\r
- //\r
- ReadyToLockEvent = EfiCreateProtocolNotifyEvent (\r
- &gEfiDxeSmmReadyToLockProtocolGuid,\r
- TPL_NOTIFY,\r
- ReadyToLockEventNotify,\r
- NULL,\r
- &Registration\r
- );\r
- ASSERT (ReadyToLockEvent != NULL);\r
- } else {\r
- //\r
- // the entry point is invoked after reloading. following code only run in RESERVED mem\r
- //\r
- if (PcdGetBool(PcdUse1GPageTable)) {\r
- AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
- if (RegEax >= 0x80000001) {\r
- AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
- if ((RegEdx & BIT26) != 0) {\r
- mPage1GSupport = TRUE;\r
- }\r
+ //\r
+ // Create ReadyToLock event to reload BootScriptExecutor image\r
+ // to RESERVED mem and save it to LockBox.\r
+ //\r
+ ReadyToLockEvent = EfiCreateProtocolNotifyEvent (\r
+ &gEfiDxeSmmReadyToLockProtocolGuid,\r
+ TPL_NOTIFY,\r
+ ReadyToLockEventNotify,\r
+ NULL,\r
+ &Registration\r
+ );\r
+ ASSERT (ReadyToLockEvent != NULL);\r
+ } else {\r
+ //\r
+ // the entry point is invoked after reloading. following code only run in RESERVED mem\r
+ //\r
+ if (PcdGetBool (PcdUse1GPageTable)) {\r
+ AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
+ if (RegEax >= 0x80000001) {\r
+ AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
+ if ((RegEdx & BIT26) != 0) {\r
+ mPage1GSupport = TRUE;\r
}\r
}\r
+ }\r
\r
- BufferSize = sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE);\r
+ BufferSize = sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE);\r
\r
- BootScriptExecutorBuffer = 0xFFFFFFFF;\r
- Pages = EFI_SIZE_TO_PAGES(BufferSize);\r
- Status = gBS->AllocatePages (\r
- AllocateMaxAddress,\r
- EfiReservedMemoryType,\r
- Pages,\r
- &BootScriptExecutorBuffer\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
+ BootScriptExecutorBuffer = 0xFFFFFFFF;\r
+ Pages = EFI_SIZE_TO_PAGES (BufferSize);\r
+ Status = gBS->AllocatePages (\r
+ AllocateMaxAddress,\r
+ EfiReservedMemoryType,\r
+ Pages,\r
+ &BootScriptExecutorBuffer\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
\r
- EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *)(UINTN)BootScriptExecutorBuffer;\r
- EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = (UINTN) S3BootScriptExecutorEntryFunction ;\r
+ EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *)(UINTN)BootScriptExecutorBuffer;\r
+ EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = (UINTN)S3BootScriptExecutorEntryFunction;\r
\r
- Status = SaveLockBox (\r
- &gEfiBootScriptExecutorVariableGuid,\r
- &BootScriptExecutorBuffer,\r
- sizeof(BootScriptExecutorBuffer)\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
+ Status = SaveLockBox (\r
+ &gEfiBootScriptExecutorVariableGuid,\r
+ &BootScriptExecutorBuffer,\r
+ sizeof (BootScriptExecutorBuffer)\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
\r
- //\r
- // Additional step for BootScript integrity\r
- // Save BootScriptExecutor context\r
- //\r
- Status = SaveLockBox (\r
- &gEfiBootScriptExecutorContextGuid,\r
- EfiBootScriptExecutorVariable,\r
- sizeof(*EfiBootScriptExecutorVariable)\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- Status = SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
- ASSERT_EFI_ERROR (Status);\r
- }\r
+ //\r
+ // Additional step for BootScript integrity\r
+ // Save BootScriptExecutor context\r
+ //\r
+ Status = SaveLockBox (\r
+ &gEfiBootScriptExecutorContextGuid,\r
+ EfiBootScriptExecutorVariable,\r
+ sizeof (*EfiBootScriptExecutorVariable)\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ Status = SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
\r
- return EFI_SUCCESS;\r
+ return EFI_SUCCESS;\r
}\r
-\r
projects / mirror_edk2.git / blobdiff