[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 NVS memory\r
  in the entry point. The functionality is to interpret and restore the S3 boot script\r
\r
Copyright (c) 2006 - 2012, Intel Corporation. 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
/**\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
  // 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
  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
    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
  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
  UINT8                                         *Buffer;\r
  UINTN                                         BufferSize;\r
  UINTN                                         Pages;\r
  EFI_PHYSICAL_ADDRESS                          FfsBuffer;\r
  PE_COFF_LOADER_IMAGE_CONTEXT                  ImageContext;\r
  BOOT_SCRIPT_EXECUTOR_VARIABLE                 *EfiBootScriptExecutorVariable;\r
  EFI_PHYSICAL_ADDRESS                          BootScriptExecutorBuffer;\r
  EFI_STATUS                                    Status;\r
  VOID                                          *DevicePath;\r
  EFI_HANDLE                                    NewImageHandle;\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
      //\r
      // This is the first-time loaded by DXE core. reload itself to NVS mem\r
      //\r
      //\r
      // A workarouond: 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
\r
      Status = GetSectionFromAnyFv  (\r
                 &gEfiCallerIdGuid,\r
                 EFI_SECTION_PE32,\r
                 0,\r
                 (VOID **) &Buffer,\r
                 &BufferSize\r
                 );\r
      ImageContext.Handle    = Buffer;\r
      ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
      //\r
      // Get information about the image being loaded\r
      //\r
      Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
      if (EFI_ERROR (Status)) {\r
        return Status;\r
      }\r
      Pages = EFI_SIZE_TO_PAGES(BufferSize + ImageContext.SectionAlignment);\r
      FfsBuffer = 0xFFFFFFFF;\r
      Status = gBS->AllocatePages (\r
                    AllocateMaxAddress,\r
                    EfiACPIMemoryNVS,\r
                    Pages,\r
                    &FfsBuffer\r
                    );\r
      if (EFI_ERROR (Status)) {\r
        return EFI_OUT_OF_RESOURCES;\r
      }\r
      ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
      //\r
      // Align buffer on section boundry\r
      //\r
      ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
      ImageContext.ImageAddress &= ~(ImageContext.SectionAlignment - 1);\r
      //\r
      // Load the image to our new buffer\r
      //\r
      Status = PeCoffLoaderLoadImage (&ImageContext);\r
      if (EFI_ERROR (Status)) {\r
        gBS->FreePages (FfsBuffer, Pages);\r
        return Status;\r
      }\r
\r
      //\r
      // Relocate the image in our new buffer\r
      //\r
      Status = PeCoffLoaderRelocateImage (&ImageContext);\r
\r
      if (EFI_ERROR (Status)) {\r
        PeCoffLoaderUnloadImage (&ImageContext);\r
        gBS->FreePages (FfsBuffer, Pages);\r
        return Status;\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
      Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint)) (NewImageHandle, SystemTable);\r
      if (EFI_ERROR (Status)) {\r
        gBS->FreePages (FfsBuffer, Pages);\r
        return 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
    } else {\r
      //\r
      // the entry point is invoked after reloading. following code only run in  ACPI NVS\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
                      EfiACPIMemoryNVS,\r
                      Pages,\r
                      &BootScriptExecutorBuffer\r
                      );\r
      if (EFI_ERROR (Status)) {\r
        return EFI_OUT_OF_RESOURCES;\r
      }\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
\r
    return EFI_SUCCESS;\r
}\r
\r
\r
\r
Commit	Line	Data
be46cd5f	1	/** @file\r
	2	This is the code for Boot Script Executer module.\r
	3	\r
	4	This driver is dispatched by Dxe core and the driver will reload itself to ACPI NVS memory\r
	5	in the entry point. The functionality is to interpret and restore the S3 boot script\r
	6	\r
5c0687cc	7	Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
be46cd5f	8	\r
	9	This program and the accompanying materials\r
	10	are licensed and made available under the terms and conditions of the BSD License\r
	11	which accompanies this distribution. The full text of the license may be found at\r
	12	http://opensource.org/licenses/bsd-license.php\r
	13	\r
	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	15	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	16	\r
	17	**/\r
	18	\r
	19	#include "ScriptExecute.h"\r
	20	\r
be46cd5f	21	EFI_GUID mBootScriptExecutorImageGuid = {\r
ce68d3bc	22	0x9a8d3433, 0x9fe8, 0x42b6, { 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b }\r
be46cd5f	23	};\r
be46cd5f	24	\r
be46cd5f	25	/**\r
	26	Entry function of Boot script exector. This function will be executed in\r
	27	S3 boot path.\r
	28	This function should not return, because it is invoked by switch stack.\r
	29	\r
	30	@param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
	31	@param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
	32	\r
	33	@retval EFI_INVALID_PARAMETER - OS waking vector not found\r
	34	@retval EFI_UNSUPPORTED - something wrong when we resume to OS\r
	35	**/\r
	36	EFI_STATUS\r
	37	EFIAPI\r
	38	S3BootScriptExecutorEntryFunction (\r
	39	IN ACPI_S3_CONTEXT *AcpiS3Context,\r
	40	IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
	41	)\r
	42	{\r
	43	EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
	44	EFI_STATUS Status;\r
	45	UINTN TempStackTop;\r
	46	UINTN TempStack[0x10];\r
	47	UINTN AsmTransferControl16Address;\r
933d80a1	48	IA32_DESCRIPTOR IdtDescriptor;\r
be46cd5f	49	\r
be46cd5f	50	//\r
	51	// Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
	52	//\r
	53	SaveAndSetDebugTimerInterrupt (FALSE);\r
	54	\r
933d80a1	55	AsmReadIdtr (&IdtDescriptor);\r
be46cd5f	56	//\r
	57	// Restore IDT for debug\r
	58	//\r
	59	SetIdtEntry (AcpiS3Context);\r
	60	\r
	61	//\r
933d80a1	62	// Initialize Debug Agent to support source level debug in S3 path, it will disable interrupt and Debug Timer.\r
be46cd5f	63	//\r
933d80a1	64	InitializeDebugAgent (DEBUG_AGENT_INIT_S3, (VOID *)&IdtDescriptor, NULL);\r
be46cd5f	65	\r
	66	//\r
	67	// Because not install BootScriptExecute PPI(used just in this module), So just pass NULL\r
	68	// for that parameter.\r
	69	//\r
be46cd5f	70	Status = S3BootScriptExecute ();\r
37623a5c	71	\r
	72	//\r
	73	// Need report status back to S3ResumePeim. \r
	74	// If boot script execution is failed, S3ResumePeim wil report the error status code.\r
	75	//\r
	76	PeiS3ResumeState->ReturnStatus = (UINT64)(UINTN)Status;\r
be46cd5f	77	\r
	78	AsmWbinvd ();\r
	79	\r
	80	//\r
	81	// Get ACPI Table Address\r
	82	//\r
	83	Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
	84	\r
be46cd5f	85	//\r
	86	// We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.\r
	87	//\r
	88	if (PeiS3ResumeState != 0) {\r
	89	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	90	//\r
	91	// X64 S3 Resume\r
	92	//\r
	93	DEBUG ((EFI_D_ERROR, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));\r
	94	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl32;\r
	95	\r
37623a5c	96	if ((Facs != NULL) &&\r
	97	(Facs->Signature == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) &&\r
	98	(Facs->FirmwareWakingVector != 0) ) {\r
	99	//\r
	100	// more step needed - because relative address is handled differently between X64 and IA32.\r
	101	//\r
	102	AsmTransferControl16Address = (UINTN)AsmTransferControl16;\r
	103	AsmFixAddress16 = (UINT32)AsmTransferControl16Address;\r
	104	AsmJmpAddr32 = (UINT32)((Facs->FirmwareWakingVector & 0xF) \| ((Facs->FirmwareWakingVector & 0xFFFF0) << 12));\r
	105	}\r
be46cd5f	106	\r
	107	AsmDisablePaging64 (\r
	108	PeiS3ResumeState->ReturnCs,\r
	109	(UINT32)PeiS3ResumeState->ReturnEntryPoint,\r
	110	(UINT32)(UINTN)AcpiS3Context,\r
	111	(UINT32)(UINTN)PeiS3ResumeState,\r
	112	(UINT32)PeiS3ResumeState->ReturnStackPointer\r
	113	);\r
	114	} else {\r
	115	//\r
	116	// IA32 S3 Resume\r
	117	//\r
	118	DEBUG ((EFI_D_ERROR, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
	119	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl;\r
	120	\r
	121	SwitchStack (\r
	122	(SWITCH_STACK_ENTRY_POINT)(UINTN)PeiS3ResumeState->ReturnEntryPoint,\r
	123	(VOID *)(UINTN)AcpiS3Context,\r
	124	(VOID *)(UINTN)PeiS3ResumeState,\r
	125	(VOID *)(UINTN)PeiS3ResumeState->ReturnStackPointer\r
	126	);\r
	127	}\r
	128	\r
	129	//\r
	130	// Never run to here\r
	131	//\r
	132	CpuDeadLoop();\r
	133	return EFI_UNSUPPORTED;\r
	134	}\r
37623a5c	135	\r
	136	//\r
	137	// S3ResumePeim does not provide a way to jump back to itself, so resume to OS here directly\r
	138	//\r
be46cd5f	139	if (Facs->XFirmwareWakingVector != 0) {\r
	140	//\r
	141	// Switch to native waking vector\r
	142	//\r
	143	TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
	144	if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
	145	((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
	146	((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
	147	//\r
	148	// X64 long mode waking vector\r
	149	//\r
	150	DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
	151	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	152	SwitchStack (\r
	153	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
	154	NULL,\r
	155	NULL,\r
	156	(VOID *)(UINTN)TempStackTop\r
	157	);\r
	158	} else {\r
	159	// Unsupported for 32bit DXE, 64bit OS vector\r
	160	DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
	161	ASSERT (FALSE);\r
	162	}\r
	163	} else {\r
	164	//\r
	165	// IA32 protected mode waking vector (Page disabled)\r
	166	//\r
	167	DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
	168	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	169	AsmDisablePaging64 (\r
	170	0x10,\r
	171	(UINT32)Facs->XFirmwareWakingVector,\r
	172	0,\r
	173	0,\r
	174	(UINT32)TempStackTop\r
	175	);\r
	176	} else {\r
	177	SwitchStack (\r
	178	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
	179	NULL,\r
	180	NULL,\r
	181	(VOID *)(UINTN)TempStackTop\r
	182	);\r
	183	}\r
	184	}\r
	185	} else {\r
	186	//\r
	187	// 16bit Realmode waking vector\r
	188	//\r
	189	DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
	190	AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
	191	}\r
	192	\r
	193	//\r
	194	// Never run to here\r
	195	//\r
	196	CpuDeadLoop();\r
	197	return EFI_UNSUPPORTED;\r
	198	}\r
	199	/**\r
	200	Entrypoint of Boot script exector driver, this function will be executed in\r
	201	normal boot phase and invoked by DXE dispatch.\r
	202	\r
203	@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
204	@param[in] SystemTable A pointer to the EFI System Table.\r
205	\r
206	@retval EFI_SUCCESS The entry point is executed successfully.\r
207	@retval other Some error occurs when executing this entry point.\r
208	**/\r
209	EFI_STATUS\r
210	EFIAPI\r
211	BootScriptExecutorEntryPoint (\r
212	IN EFI_HANDLE ImageHandle,\r
213	IN EFI_SYSTEM_TABLE *SystemTable\r
214	)\r
215	{\r
216	UINT8 *Buffer;\r
217	UINTN BufferSize;\r
218	UINTN Pages;\r
219	EFI_PHYSICAL_ADDRESS FfsBuffer;\r
220	PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
221	BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
222	EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer;\r
223	EFI_STATUS Status;\r
224	VOID *DevicePath;\r
225	EFI_HANDLE NewImageHandle;\r
226	\r
227	//\r
228	// Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry\r
229	// point is loaded by DXE code which is the first time loaded. or else, it is already\r
230	// be reloaded be itself.This is a work-around\r
231	//\r
232	Status = gBS->LocateProtocol (&gEfiCallerIdGuid, NULL, &DevicePath);\r
233	if (EFI_ERROR (Status)) {\r
234	\r
235	//\r
236	// This is the first-time loaded by DXE core. reload itself to NVS mem\r
237	//\r
238	//\r
239	// A workarouond: Here we install a dummy handle\r
240	//\r
241	NewImageHandle = NULL;\r
242	Status = gBS->InstallProtocolInterface (\r
243	&NewImageHandle,\r
244	&gEfiCallerIdGuid,\r
245	EFI_NATIVE_INTERFACE,\r
246	NULL\r
247	);\r
248	\r
249	Status = GetSectionFromAnyFv (\r
250	&gEfiCallerIdGuid,\r
251	EFI_SECTION_PE32,\r
252	0,\r
253	(VOID **) &Buffer,\r
254	&BufferSize\r
255	);\r
256	ImageContext.Handle = Buffer;\r
257	ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
258	//\r
259	// Get information about the image being loaded\r
260	//\r
261	Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
262	if (EFI_ERROR (Status)) {\r
263	return Status;\r
264	}\r
265	Pages = EFI_SIZE_TO_PAGES(BufferSize + ImageContext.SectionAlignment);\r
266	FfsBuffer = 0xFFFFFFFF;\r
267	Status = gBS->AllocatePages (\r
268	AllocateMaxAddress,\r
269	EfiACPIMemoryNVS,\r
270	Pages,\r
271	&FfsBuffer\r
272	);\r
273	if (EFI_ERROR (Status)) {\r
274	return EFI_OUT_OF_RESOURCES;\r
275	}\r
276	ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
277	//\r
278	// Align buffer on section boundry\r
279	//\r
280	ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
281	ImageContext.ImageAddress &= ~(ImageContext.SectionAlignment - 1);\r
282	//\r
283	// Load the image to our new buffer\r
284	//\r
285	Status = PeCoffLoaderLoadImage (&ImageContext);\r
286	if (EFI_ERROR (Status)) {\r
287	gBS->FreePages (FfsBuffer, Pages);\r
288	return Status;\r
289	}\r
290	\r
291	//\r
292	// Relocate the image in our new buffer\r
293	//\r
294	Status = PeCoffLoaderRelocateImage (&ImageContext);\r
295	\r
296	if (EFI_ERROR (Status)) {\r
297	PeCoffLoaderUnloadImage (&ImageContext);\r
298	gBS->FreePages (FfsBuffer, Pages);\r
299	return Status;\r
300	}\r
301	//\r
302	// Flush the instruction cache so the image data is written before we execute it\r
303	//\r
304	InvalidateInstructionCacheRange ((VOID *)(UINTN)ImageContext.ImageAddress, (UINTN)ImageContext.ImageSize);\r
305	Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint)) (NewImageHandle, SystemTable);\r
306	if (EFI_ERROR (Status)) {\r
307	gBS->FreePages (FfsBuffer, Pages);\r
308	return Status;\r
309	}\r
310	//\r
311	// Additional step for BootScript integrity\r
312	// Save BootScriptExecutor image\r
313	//\r
314	Status = SaveLockBox (\r
315	&mBootScriptExecutorImageGuid,\r
316	(VOID *)(UINTN)ImageContext.ImageAddress,\r
317	(UINTN)ImageContext.ImageSize\r
318	);\r
319	ASSERT_EFI_ERROR (Status);\r
320	\r
321	Status = SetLockBoxAttributes (&mBootScriptExecutorImageGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
322	ASSERT_EFI_ERROR (Status);\r
323	\r
324	} else {\r
325	//\r
326	// the entry point is invoked after reloading. following code only run in ACPI NVS\r
327	//\r
328	BufferSize = sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE);\r
329	\r
330	BootScriptExecutorBuffer = 0xFFFFFFFF;\r
331	Pages = EFI_SIZE_TO_PAGES(BufferSize);\r
332	Status = gBS->AllocatePages (\r
333	AllocateMaxAddress,\r
334	EfiACPIMemoryNVS,\r
335	Pages,\r
336	&BootScriptExecutorBuffer\r
337	);\r
338	if (EFI_ERROR (Status)) {\r
339	return EFI_OUT_OF_RESOURCES;\r
340	}\r
341	\r
342	EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *)(UINTN)BootScriptExecutorBuffer;\r
343	EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = (UINTN) S3BootScriptExecutorEntryFunction ;\r
344	\r
345	Status = SaveLockBox (\r
346	&gEfiBootScriptExecutorVariableGuid,\r
347	&BootScriptExecutorBuffer,\r
348	sizeof(BootScriptExecutorBuffer)\r
349	);\r
350	ASSERT_EFI_ERROR (Status);\r
351	\r
352	//\r
353	// Additional step for BootScript integrity\r
354	// Save BootScriptExecutor context\r
355	//\r
356	Status = SaveLockBox (\r
357	&gEfiBootScriptExecutorContextGuid,\r
358	EfiBootScriptExecutorVariable,\r
359	sizeof(*EfiBootScriptExecutorVariable)\r
360	);\r
361	ASSERT_EFI_ERROR (Status);\r
362	\r
363	Status = SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
364	ASSERT_EFI_ERROR (Status);\r
365	\r
be46cd5f	366	}\r
	367	\r
	368	return EFI_SUCCESS;\r
	369	}\r
	370	\r
	371	\r
	372	\r