[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / BootScriptExecutorDxe / ScriptExecute.c

/** @file\r
  This is the code for Boot Script Executer module.\r
\r
  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 - 2016, 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
\r
**/\r
\r
#include "ScriptExecute.h"\r
\r
EFI_GUID              mBootScriptExecutorImageGuid = {\r
  0x9a8d3433, 0x9fe8, 0x42b6, { 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b }\r
};\r
\r
BOOLEAN               mPage1GSupport = FALSE;\r
UINT64                mAddressEncMask = 0;\r
\r
/**\r
  Entry function of Boot script exector. This function will be executed in\r
  S3 boot path.\r
  This function should not return, because it is invoked by switch stack.\r
\r
  @param  AcpiS3Context    a pointer to a structure of ACPI_S3_CONTEXT\r
  @param  PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
\r
  @retval EFI_INVALID_PARAMETER - OS waking vector not found\r
  @retval EFI_UNSUPPORTED - something wrong when we resume to OS\r
**/\r
EFI_STATUS\r
EFIAPI\r
S3BootScriptExecutorEntryFunction (\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
  EFI_STATUS                                    Status;\r
  UINTN                                         TempStackTop;\r
  UINTN                                         TempStack[0x10];\r
  UINTN                                         AsmTransferControl16Address;\r
  IA32_DESCRIPTOR                               IdtDescriptor;\r
\r
  //\r
  // Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
  //\r
  SaveAndSetDebugTimerInterrupt (FALSE);\r
\r
  AsmReadIdtr (&IdtDescriptor);\r
  //\r
  // Restore IDT for debug\r
  //\r
  SetIdtEntry (AcpiS3Context);\r
\r
  //\r
  // Initialize Debug Agent to support source level debug in S3 path, it will disable interrupt and Debug Timer.\r
  //\r
  InitializeDebugAgent (DEBUG_AGENT_INIT_S3, (VOID *)&IdtDescriptor, NULL);\r
\r
  //\r
  // Because not install BootScriptExecute PPI(used just in this module), So just pass NULL\r
  // for that parameter.\r
  //\r
  Status = S3BootScriptExecute ();\r
  \r
  //\r
  // If invalid script table or opcode in S3 boot script table.\r
  //\r
  ASSERT_EFI_ERROR (Status);\r
  \r
  if (EFI_ERROR (Status)) {\r
    CpuDeadLoop ();\r
    return Status;\r
  }\r
\r
  AsmWbinvd ();\r
\r
  //\r
  // Get ACPI Table Address\r
  //\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
    // If boot script execution is failed, S3ResumePeim wil report the error status code.\r
    //\r
    PeiS3ResumeState->ReturnStatus = (UINT64)(UINTN)Status;\r
    if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
      //\r
      // X64 S3 Resume\r
      //\r
      DEBUG ((EFI_D_ERROR, "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
        //\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
      }\r
\r
      AsmDisablePaging64 (\r
        PeiS3ResumeState->ReturnCs,\r
        (UINT32)PeiS3ResumeState->ReturnEntryPoint,\r
        (UINT32)(UINTN)AcpiS3Context,\r
        (UINT32)(UINTN)PeiS3ResumeState,\r
        (UINT32)PeiS3ResumeState->ReturnStackPointer\r
        );\r
    } else {\r
      //\r
      // IA32 S3 Resume\r
      //\r
      DEBUG ((EFI_D_ERROR, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
      PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl;\r
\r
      SwitchStack (\r
        (SWITCH_STACK_ENTRY_POINT)(UINTN)PeiS3ResumeState->ReturnEntryPoint,\r
        (VOID *)(UINTN)AcpiS3Context,\r
        (VOID *)(UINTN)PeiS3ResumeState,\r
        (VOID *)(UINTN)PeiS3ResumeState->ReturnStackPointer\r
        );\r
    }\r
\r
    //\r
    // Never run to here\r
    //\r
    CpuDeadLoop();\r
    return EFI_UNSUPPORTED;\r
  }\r
  \r
  //\r
  // S3ResumePeim does not provide a way to jump back to itself, so resume to OS here directly\r
  //\r
  if (Facs->XFirmwareWakingVector != 0) {\r
    //\r
    // Switch to native waking vector\r
    //\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
      //\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
      if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
        SwitchStack (\r
          (SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
          NULL,\r
          NULL,\r
          (VOID *)(UINTN)TempStackTop\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
        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
      if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
        AsmDisablePaging64 (\r
          0x10,\r
          (UINT32)Facs->XFirmwareWakingVector,\r
          0,\r
          0,\r
          (UINT32)TempStackTop\r
          );\r
      } else {\r
        SwitchStack (\r
          (SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
          NULL,\r
          NULL,\r
          (VOID *)(UINTN)TempStackTop\r
          );\r
      }\r
    }\r
  } else {\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
    AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
  }\r
\r
  //\r
  // Never run to here\r
  //\r
  CpuDeadLoop();\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Register image to memory profile.\r
\r
  @param FileName       File name of the image.\r
  @param ImageBase      Image base address.\r
  @param ImageSize      Image size.\r
  @param FileType       File type of the image.\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
  )\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
\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
    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
                                  ImageBase,\r
                                  ImageSize,\r
                                  FileType\r
                                  );\r
    }\r
  }\r
}\r
\r
/**\r
  This is the Event notification function to reload BootScriptExecutor image\r
  to RESERVED mem and save it to LockBox.\r
  \r
  @param    Event   Pointer to this event\r
  @param    Context Event handler private data \r
 **/\r
VOID\r
EFIAPI\r
ReadyToLockEventNotify (\r
  IN EFI_EVENT  Event,\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
\r
  Status = gBS->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid, NULL, &Interface);\r
  if (EFI_ERROR (Status)) {\r
    return;\r
  }\r
\r
  //\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
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Reload BootScriptExecutor image itself to RESERVED mem\r
  //\r
  Status = GetSectionFromAnyFv  (\r
             &gEfiCallerIdGuid,\r
             EFI_SECTION_PE32,\r
             0,\r
             (VOID **) &Buffer,\r
             &BufferSize\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
  ImageContext.Handle    = Buffer;\r
  ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
  //\r
  // Get information about the image being loaded\r
  //\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
  } else {\r
    Pages = EFI_SIZE_TO_PAGES ((UINTN) ImageContext.ImageSize);\r
  }\r
  FfsBuffer = 0xFFFFFFFF;\r
  Status = gBS->AllocatePages (\r
                  AllocateMaxAddress,\r
                  EfiReservedMemoryType,\r
                  Pages,\r
                  &FfsBuffer\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
  ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
  //\r
  // Align buffer on section boundary\r
  //\r
  ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
  ImageContext.ImageAddress &= ~((EFI_PHYSICAL_ADDRESS)(ImageContext.SectionAlignment - 1));\r
  //\r
  // Load the image to our new buffer\r
  //\r
  Status = PeCoffLoaderLoadImage (&ImageContext);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Relocate the image in our new buffer\r
  //\r
  Status = PeCoffLoaderRelocateImage (&ImageContext);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Free the buffer allocated by ReadSection since the image has been relocated in the new buffer\r
  //\r
  gBS->FreePool (Buffer);\r
\r
  //\r
  // Flush the instruction cache so the image data is written before we execute it\r
  //\r
  InvalidateInstructionCacheRange ((VOID *)(UINTN)ImageContext.ImageAddress, (UINTN)ImageContext.ImageSize);\r
\r
  RegisterMemoryProfileImage (\r
    &gEfiCallerIdGuid,\r
    ImageContext.ImageAddress,\r
    ImageContext.ImageSize,\r
    EFI_FV_FILETYPE_DRIVER\r
    );\r
\r
  Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint)) (NewImageHandle, gST);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Additional step for BootScript integrity\r
  // Save BootScriptExecutor image\r
  //\r
  Status = SaveLockBox (\r
             &mBootScriptExecutorImageGuid,\r
             (VOID *)(UINTN)ImageContext.ImageAddress,\r
             (UINTN)ImageContext.ImageSize\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = SetLockBoxAttributes (&mBootScriptExecutorImageGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  gBS->CloseEvent (Event);\r
}\r
\r
/**\r
  Entrypoint of Boot script exector driver, this function will be executed in\r
  normal boot phase and invoked by DXE dispatch.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.\r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootScriptExecutorEntryPoint (\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
\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
  // point is loaded by DXE code which is the first time loaded. or else, it is already\r
  // be reloaded be itself.This is a work-around\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
      }\r
\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
\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
\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
}\r
\r
Commit	Line	Data
be46cd5f	1	/** @file\r
	2	This is the code for Boot Script Executer module.\r
	3	\r
59cc677c	4	This driver is dispatched by Dxe core and the driver will reload itself to ACPI reserved memory\r
be46cd5f	5	in the entry point. The functionality is to interpret and restore the S3 boot script\r
be46cd5f	6	\r
800c02fb	7	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
ab1a5a58	8	Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
be46cd5f	9	\r
	10	This program and the accompanying materials\r
	11	are licensed and made available under the terms and conditions of the BSD License\r
	12	which accompanies this distribution. The full text of the license may be found at\r
	13	http://opensource.org/licenses/bsd-license.php\r
	14	\r
	15	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	16	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	17	\r
	18	**/\r
	19	\r
	20	#include "ScriptExecute.h"\r
	21	\r
be46cd5f	22	EFI_GUID mBootScriptExecutorImageGuid = {\r
ce68d3bc	23	0x9a8d3433, 0x9fe8, 0x42b6, { 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b }\r
be46cd5f	24	};\r
be46cd5f	25	\r
59cc677c	26	BOOLEAN mPage1GSupport = FALSE;\r
ab1a5a58	27	UINT64 mAddressEncMask = 0;\r
59cc677c	28	\r
be46cd5f	29	/**\r
	30	Entry function of Boot script exector. This function will be executed in\r
	31	S3 boot path.\r
	32	This function should not return, because it is invoked by switch stack.\r
	33	\r
	34	@param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
	35	@param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
	36	\r
	37	@retval EFI_INVALID_PARAMETER - OS waking vector not found\r
	38	@retval EFI_UNSUPPORTED - something wrong when we resume to OS\r
	39	**/\r
	40	EFI_STATUS\r
	41	EFIAPI\r
	42	S3BootScriptExecutorEntryFunction (\r
	43	IN ACPI_S3_CONTEXT *AcpiS3Context,\r
	44	IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
	45	)\r
	46	{\r
	47	EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
	48	EFI_STATUS Status;\r
	49	UINTN TempStackTop;\r
	50	UINTN TempStack[0x10];\r
	51	UINTN AsmTransferControl16Address;\r
933d80a1	52	IA32_DESCRIPTOR IdtDescriptor;\r
be46cd5f	53	\r
be46cd5f	54	//\r
	55	// Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
	56	//\r
	57	SaveAndSetDebugTimerInterrupt (FALSE);\r
	58	\r
933d80a1	59	AsmReadIdtr (&IdtDescriptor);\r
be46cd5f	60	//\r
	61	// Restore IDT for debug\r
	62	//\r
	63	SetIdtEntry (AcpiS3Context);\r
	64	\r
	65	//\r
933d80a1	66	// Initialize Debug Agent to support source level debug in S3 path, it will disable interrupt and Debug Timer.\r
be46cd5f	67	//\r
933d80a1	68	InitializeDebugAgent (DEBUG_AGENT_INIT_S3, (VOID *)&IdtDescriptor, NULL);\r
be46cd5f	69	\r
	70	//\r
	71	// Because not install BootScriptExecute PPI(used just in this module), So just pass NULL\r
	72	// for that parameter.\r
	73	//\r
be46cd5f	74	Status = S3BootScriptExecute ();\r
c48abbed SQ	75	\r
	76	//\r
	77	// If invalid script table or opcode in S3 boot script table.\r
	78	//\r
	79	ASSERT_EFI_ERROR (Status);\r
	80	\r
	81	if (EFI_ERROR (Status)) {\r
	82	CpuDeadLoop ();\r
	83	return Status;\r
	84	}\r
37623a5c	85	\r
be46cd5f	86	AsmWbinvd ();\r
	87	\r
	88	//\r
	89	// Get ACPI Table Address\r
	90	//\r
	91	Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
	92	\r
be46cd5f	93	//\r
	94	// We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.\r
	95	//\r
	96	if (PeiS3ResumeState != 0) {\r
17dd0f2b	97	//\r
	98	// Need report status back to S3ResumePeim. \r
	99	// If boot script execution is failed, S3ResumePeim wil report the error status code.\r
	100	//\r
	101	PeiS3ResumeState->ReturnStatus = (UINT64)(UINTN)Status;\r
be46cd5f	102	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	103	//\r
	104	// X64 S3 Resume\r
	105	//\r
	106	DEBUG ((EFI_D_ERROR, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));\r
	107	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl32;\r
	108	\r
37623a5c	109	if ((Facs != NULL) &&\r
	110	(Facs->Signature == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) &&\r
	111	(Facs->FirmwareWakingVector != 0) ) {\r
	112	//\r
	113	// more step needed - because relative address is handled differently between X64 and IA32.\r
	114	//\r
	115	AsmTransferControl16Address = (UINTN)AsmTransferControl16;\r
	116	AsmFixAddress16 = (UINT32)AsmTransferControl16Address;\r
	117	AsmJmpAddr32 = (UINT32)((Facs->FirmwareWakingVector & 0xF) \| ((Facs->FirmwareWakingVector & 0xFFFF0) << 12));\r
	118	}\r
be46cd5f	119	\r
	120	AsmDisablePaging64 (\r
	121	PeiS3ResumeState->ReturnCs,\r
	122	(UINT32)PeiS3ResumeState->ReturnEntryPoint,\r
	123	(UINT32)(UINTN)AcpiS3Context,\r
	124	(UINT32)(UINTN)PeiS3ResumeState,\r
	125	(UINT32)PeiS3ResumeState->ReturnStackPointer\r
	126	);\r
	127	} else {\r
	128	//\r
	129	// IA32 S3 Resume\r
	130	//\r
	131	DEBUG ((EFI_D_ERROR, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
	132	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl;\r
	133	\r
	134	SwitchStack (\r
	135	(SWITCH_STACK_ENTRY_POINT)(UINTN)PeiS3ResumeState->ReturnEntryPoint,\r
	136	(VOID *)(UINTN)AcpiS3Context,\r
	137	(VOID *)(UINTN)PeiS3ResumeState,\r
	138	(VOID *)(UINTN)PeiS3ResumeState->ReturnStackPointer\r
	139	);\r
	140	}\r
	141	\r
	142	//\r
	143	// Never run to here\r
	144	//\r
	145	CpuDeadLoop();\r
	146	return EFI_UNSUPPORTED;\r
	147	}\r
37623a5c	148	\r
	149	//\r
	150	// S3ResumePeim does not provide a way to jump back to itself, so resume to OS here directly\r
	151	//\r
be46cd5f	152	if (Facs->XFirmwareWakingVector != 0) {\r
	153	//\r
	154	// Switch to native waking vector\r
	155	//\r
	156	TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
	157	if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
	158	((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
	159	((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
	160	//\r
	161	// X64 long mode waking vector\r
	162	//\r
	163	DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
	164	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	165	SwitchStack (\r
	166	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
	167	NULL,\r
	168	NULL,\r
	169	(VOID *)(UINTN)TempStackTop\r
	170	);\r
	171	} else {\r
	172	// Unsupported for 32bit DXE, 64bit OS vector\r
	173	DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
	174	ASSERT (FALSE);\r
	175	}\r
	176	} else {\r
	177	//\r
	178	// IA32 protected mode waking vector (Page disabled)\r
	179	//\r
	180	DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
	181	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	182	AsmDisablePaging64 (\r
	183	0x10,\r
	184	(UINT32)Facs->XFirmwareWakingVector,\r
	185	0,\r
	186	0,\r
	187	(UINT32)TempStackTop\r
	188	);\r
	189	} else {\r
	190	SwitchStack (\r
	191	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
	192	NULL,\r
	193	NULL,\r
	194	(VOID *)(UINTN)TempStackTop\r
	195	);\r
	196	}\r
	197	}\r
	198	} else {\r
	199	//\r
	200	// 16bit Realmode waking vector\r
	201	//\r
	202	DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
	203	AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
	204	}\r
	205	\r
	206	//\r
	207	// Never run to here\r
	208	//\r
	209	CpuDeadLoop();\r
	210	return EFI_UNSUPPORTED;\r
	211	}\r
59cc677c	212	\r
84edd20b SZ	213	/**\r
	214	Register image to memory profile.\r
	215	\r
	216	@param FileName File name of the image.\r
	217	@param ImageBase Image base address.\r
	218	@param ImageSize Image size.\r
	219	@param FileType File type of the image.\r
	220	\r
	221	**/\r
	222	VOID\r
	223	RegisterMemoryProfileImage (\r
	224	IN EFI_GUID *FileName,\r
	225	IN PHYSICAL_ADDRESS ImageBase,\r
	226	IN UINT64 ImageSize,\r
	227	IN EFI_FV_FILETYPE FileType\r
	228	)\r
	229	{\r
	230	EFI_STATUS Status;\r
	231	EDKII_MEMORY_PROFILE_PROTOCOL *ProfileProtocol;\r
	232	MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FilePath;\r
	233	UINT8 TempBuffer[sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH) + sizeof (EFI_DEVICE_PATH_PROTOCOL)];\r
	234	\r
	235	if ((PcdGet8 (PcdMemoryProfilePropertyMask) & BIT0) != 0) {\r
	236	\r
	237	FilePath = (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)TempBuffer;\r
	238	Status = gBS->LocateProtocol (&gEdkiiMemoryProfileGuid, NULL, (VOID **) &ProfileProtocol);\r
	239	if (!EFI_ERROR (Status)) {\r
	240	EfiInitializeFwVolDevicepathNode (FilePath, FileName);\r
	241	SetDevicePathEndNode (FilePath + 1);\r
	242	\r
	243	Status = ProfileProtocol->RegisterImage (\r
	244	ProfileProtocol,\r
	245	(EFI_DEVICE_PATH_PROTOCOL *) FilePath,\r
	246	ImageBase,\r
	247	ImageSize,\r
	248	FileType\r
	249	);\r
	250	}\r
	251	}\r
	252	}\r
	253	\r
59cc677c SZ	254	/**\r
	255	This is the Event notification function to reload BootScriptExecutor image\r
	256	to RESERVED mem and save it to LockBox.\r
	257	\r
	258	@param Event Pointer to this event\r
e3644786	259	@param Context Event handler private data \r
59cc677c SZ	260	**/\r
	261	VOID\r
	262	EFIAPI\r
	263	ReadyToLockEventNotify (\r
	264	IN EFI_EVENT Event,\r
	265	IN VOID *Context\r
	266	)\r
	267	{\r
	268	EFI_STATUS Status;\r
	269	VOID *Interface;\r
	270	UINT8 *Buffer;\r
	271	UINTN BufferSize;\r
	272	EFI_HANDLE NewImageHandle;\r
	273	UINTN Pages;\r
	274	EFI_PHYSICAL_ADDRESS FfsBuffer;\r
	275	PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
	276	\r
	277	Status = gBS->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid, NULL, &Interface);\r
	278	if (EFI_ERROR (Status)) {\r
	279	return;\r
	280	}\r
	281	\r
	282	//\r
	283	// A workaround: Here we install a dummy handle\r
	284	//\r
	285	NewImageHandle = NULL;\r
	286	Status = gBS->InstallProtocolInterface (\r
	287	&NewImageHandle,\r
	288	&gEfiCallerIdGuid,\r
	289	EFI_NATIVE_INTERFACE,\r
	290	NULL\r
	291	);\r
	292	ASSERT_EFI_ERROR (Status);\r
	293	\r
	294	//\r
	295	// Reload BootScriptExecutor image itself to RESERVED mem\r
	296	//\r
	297	Status = GetSectionFromAnyFv (\r
	298	&gEfiCallerIdGuid,\r
	299	EFI_SECTION_PE32,\r
	300	0,\r
	301	(VOID **) &Buffer,\r
	302	&BufferSize\r
	303	);\r
	304	ASSERT_EFI_ERROR (Status);\r
	305	ImageContext.Handle = Buffer;\r
	306	ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
	307	//\r
	308	// Get information about the image being loaded\r
	309	//\r
	310	Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
	311	ASSERT_EFI_ERROR (Status);\r
32a81741	312	if (ImageContext.SectionAlignment > EFI_PAGE_SIZE) {\r
afe5262e	313	Pages = EFI_SIZE_TO_PAGES ((UINTN) (ImageContext.ImageSize + ImageContext.SectionAlignment));\r
32a81741	314	} else {\r
afe5262e	315	Pages = EFI_SIZE_TO_PAGES ((UINTN) ImageContext.ImageSize);\r
32a81741	316	}\r
59cc677c SZ	317	FfsBuffer = 0xFFFFFFFF;\r
	318	Status = gBS->AllocatePages (\r
	319	AllocateMaxAddress,\r
	320	EfiReservedMemoryType,\r
	321	Pages,\r
	322	&FfsBuffer\r
	323	);\r
	324	ASSERT_EFI_ERROR (Status);\r
	325	ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
	326	//\r
0a18956d	327	// Align buffer on section boundary\r
59cc677c SZ	328	//\r
59cc677c SZ	329	ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
6e1e5405	330	ImageContext.ImageAddress &= ~((EFI_PHYSICAL_ADDRESS)(ImageContext.SectionAlignment - 1));\r
59cc677c SZ	331	//\r
	332	// Load the image to our new buffer\r
	333	//\r
	334	Status = PeCoffLoaderLoadImage (&ImageContext);\r
	335	ASSERT_EFI_ERROR (Status);\r
	336	\r
	337	//\r
	338	// Relocate the image in our new buffer\r
	339	//\r
	340	Status = PeCoffLoaderRelocateImage (&ImageContext);\r
	341	ASSERT_EFI_ERROR (Status);\r
	342	\r
	343	//\r
	344	// Free the buffer allocated by ReadSection since the image has been relocated in the new buffer\r
	345	//\r
	346	gBS->FreePool (Buffer);\r
	347	\r
	348	//\r
	349	// Flush the instruction cache so the image data is written before we execute it\r
	350	//\r
	351	InvalidateInstructionCacheRange ((VOID *)(UINTN)ImageContext.ImageAddress, (UINTN)ImageContext.ImageSize);\r
84edd20b SZ	352	\r
	353	RegisterMemoryProfileImage (\r
	354	&gEfiCallerIdGuid,\r
	355	ImageContext.ImageAddress,\r
	356	ImageContext.ImageSize,\r
	357	EFI_FV_FILETYPE_DRIVER\r
	358	);\r
	359	\r
59cc677c SZ	360	Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint)) (NewImageHandle, gST);\r
	361	ASSERT_EFI_ERROR (Status);\r
	362	\r
	363	//\r
	364	// Additional step for BootScript integrity\r
	365	// Save BootScriptExecutor image\r
	366	//\r
	367	Status = SaveLockBox (\r
	368	&mBootScriptExecutorImageGuid,\r
	369	(VOID *)(UINTN)ImageContext.ImageAddress,\r
	370	(UINTN)ImageContext.ImageSize\r
	371	);\r
	372	ASSERT_EFI_ERROR (Status);\r
	373	\r
	374	Status = SetLockBoxAttributes (&mBootScriptExecutorImageGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
	375	ASSERT_EFI_ERROR (Status);\r
	376	\r
	377	gBS->CloseEvent (Event);\r
	378	}\r
	379	\r
be46cd5f	380	/**\r
	381	Entrypoint of Boot script exector driver, this function will be executed in\r
	382	normal boot phase and invoked by DXE dispatch.\r
	383	\r
	384	@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
	385	@param[in] SystemTable A pointer to the EFI System Table.\r
	386	\r
	387	@retval EFI_SUCCESS The entry point is executed successfully.\r
	388	@retval other Some error occurs when executing this entry point.\r
	389	**/\r
	390	EFI_STATUS\r
	391	EFIAPI\r
	392	BootScriptExecutorEntryPoint (\r
	393	IN EFI_HANDLE ImageHandle,\r
	394	IN EFI_SYSTEM_TABLE *SystemTable\r
	395	)\r
	396	{\r
be46cd5f	397	UINTN BufferSize;\r
be46cd5f	398	UINTN Pages;\r
be46cd5f	399	BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
	400	EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer;\r
	401	EFI_STATUS Status;\r
	402	VOID *DevicePath;\r
59cc677c SZ	403	EFI_EVENT ReadyToLockEvent;\r
	404	VOID *Registration;\r
	405	UINT32 RegEax;\r
	406	UINT32 RegEdx;\r
be46cd5f	407	\r
800c02fb SZ	408	if (!PcdGetBool (PcdAcpiS3Enable)) {\r
	409	return EFI_UNSUPPORTED;\r
	410	}\r
	411	\r
ab1a5a58 LD	412	//\r
	413	// Make sure AddressEncMask is contained to smallest supported address field.\r
	414	//\r
	415	mAddressEncMask = PcdGet64 (PcdPteMemoryEncryptionAddressOrMask) & PAGING_1G_ADDRESS_MASK_64;\r
	416	\r
be46cd5f	417	//\r
	418	// Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry\r
	419	// point is loaded by DXE code which is the first time loaded. or else, it is already\r
	420	// be reloaded be itself.This is a work-around\r
	421	//\r
	422	Status = gBS->LocateProtocol (&gEfiCallerIdGuid, NULL, &DevicePath);\r
	423	if (EFI_ERROR (Status)) {\r
be46cd5f	424	//\r
59cc677c SZ	425	// Create ReadyToLock event to reload BootScriptExecutor image\r
59cc677c SZ	426	// to RESERVED mem and save it to LockBox.\r
be46cd5f	427	//\r
59cc677c SZ	428	ReadyToLockEvent = EfiCreateProtocolNotifyEvent (\r
	429	&gEfiDxeSmmReadyToLockProtocolGuid,\r
	430	TPL_NOTIFY,\r
	431	ReadyToLockEventNotify,\r
	432	NULL,\r
	433	&Registration\r
	434	);\r
	435	ASSERT (ReadyToLockEvent != NULL);\r
be46cd5f	436	} else {\r
be46cd5f	437	//\r
bad73446	438	// the entry point is invoked after reloading. following code only run in RESERVED mem\r
be46cd5f	439	//\r
59cc677c SZ	440	if (PcdGetBool(PcdUse1GPageTable)) {\r
	441	AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
	442	if (RegEax >= 0x80000001) {\r
	443	AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
	444	if ((RegEdx & BIT26) != 0) {\r
	445	mPage1GSupport = TRUE;\r
	446	}\r
	447	}\r
	448	}\r
	449	\r
be46cd5f	450	BufferSize = sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE);\r
	451	\r
	452	BootScriptExecutorBuffer = 0xFFFFFFFF;\r
	453	Pages = EFI_SIZE_TO_PAGES(BufferSize);\r
	454	Status = gBS->AllocatePages (\r
	455	AllocateMaxAddress,\r
bad73446	456	EfiReservedMemoryType,\r
be46cd5f	457	Pages,\r
	458	&BootScriptExecutorBuffer\r
	459	);\r
e0d216f6	460	ASSERT_EFI_ERROR (Status);\r
be46cd5f	461	\r
	462	EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *)(UINTN)BootScriptExecutorBuffer;\r
	463	EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = (UINTN) S3BootScriptExecutorEntryFunction ;\r
	464	\r
	465	Status = SaveLockBox (\r
	466	&gEfiBootScriptExecutorVariableGuid,\r
	467	&BootScriptExecutorBuffer,\r
	468	sizeof(BootScriptExecutorBuffer)\r
	469	);\r
	470	ASSERT_EFI_ERROR (Status);\r
	471	\r
	472	//\r
	473	// Additional step for BootScript integrity\r
	474	// Save BootScriptExecutor context\r
	475	//\r
	476	Status = SaveLockBox (\r
	477	&gEfiBootScriptExecutorContextGuid,\r
	478	EfiBootScriptExecutorVariable,\r
	479	sizeof(*EfiBootScriptExecutorVariable)\r
	480	);\r
	481	ASSERT_EFI_ERROR (Status);\r
	482	\r
	483	Status = SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
	484	ASSERT_EFI_ERROR (Status);\r
be46cd5f	485	}\r
	486	\r
	487	return EFI_SUCCESS;\r
	488	}\r
	489	\r