[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 - 2013, 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
BOOLEAN               mPage1GSupport = FALSE;\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
  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
  Pages = EFI_SIZE_TO_PAGES(BufferSize + ImageContext.SectionAlignment);\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 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
  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
  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
  //\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
59cc677c	7	Copyright (c) 2006 - 2013, 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
59cc677c SZ	25	BOOLEAN mPage1GSupport = FALSE;\r
59cc677c SZ	26	\r
be46cd5f	27	/**\r
	28	Entry function of Boot script exector. This function will be executed in\r
	29	S3 boot path.\r
	30	This function should not return, because it is invoked by switch stack.\r
	31	\r
	32	@param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
	33	@param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
	34	\r
	35	@retval EFI_INVALID_PARAMETER - OS waking vector not found\r
	36	@retval EFI_UNSUPPORTED - something wrong when we resume to OS\r
	37	**/\r
	38	EFI_STATUS\r
	39	EFIAPI\r
	40	S3BootScriptExecutorEntryFunction (\r
	41	IN ACPI_S3_CONTEXT *AcpiS3Context,\r
	42	IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
	43	)\r
	44	{\r
	45	EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
	46	EFI_STATUS Status;\r
	47	UINTN TempStackTop;\r
	48	UINTN TempStack[0x10];\r
	49	UINTN AsmTransferControl16Address;\r
933d80a1	50	IA32_DESCRIPTOR IdtDescriptor;\r
be46cd5f	51	\r
be46cd5f	52	//\r
	53	// Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
	54	//\r
	55	SaveAndSetDebugTimerInterrupt (FALSE);\r
	56	\r
933d80a1	57	AsmReadIdtr (&IdtDescriptor);\r
be46cd5f	58	//\r
	59	// Restore IDT for debug\r
	60	//\r
	61	SetIdtEntry (AcpiS3Context);\r
	62	\r
	63	//\r
933d80a1	64	// Initialize Debug Agent to support source level debug in S3 path, it will disable interrupt and Debug Timer.\r
be46cd5f	65	//\r
933d80a1	66	InitializeDebugAgent (DEBUG_AGENT_INIT_S3, (VOID *)&IdtDescriptor, NULL);\r
be46cd5f	67	\r
	68	//\r
	69	// Because not install BootScriptExecute PPI(used just in this module), So just pass NULL\r
	70	// for that parameter.\r
	71	//\r
be46cd5f	72	Status = S3BootScriptExecute ();\r
c48abbed SQ	73	\r
	74	//\r
	75	// If invalid script table or opcode in S3 boot script table.\r
	76	//\r
	77	ASSERT_EFI_ERROR (Status);\r
	78	\r
	79	if (EFI_ERROR (Status)) {\r
	80	CpuDeadLoop ();\r
	81	return Status;\r
	82	}\r
37623a5c	83	\r
be46cd5f	84	AsmWbinvd ();\r
	85	\r
	86	//\r
	87	// Get ACPI Table Address\r
	88	//\r
	89	Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
	90	\r
be46cd5f	91	//\r
	92	// We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.\r
	93	//\r
	94	if (PeiS3ResumeState != 0) {\r
17dd0f2b	95	//\r
	96	// Need report status back to S3ResumePeim. \r
	97	// If boot script execution is failed, S3ResumePeim wil report the error status code.\r
	98	//\r
	99	PeiS3ResumeState->ReturnStatus = (UINT64)(UINTN)Status;\r
be46cd5f	100	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	101	//\r
	102	// X64 S3 Resume\r
	103	//\r
	104	DEBUG ((EFI_D_ERROR, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));\r
	105	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl32;\r
	106	\r
37623a5c	107	if ((Facs != NULL) &&\r
	108	(Facs->Signature == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) &&\r
	109	(Facs->FirmwareWakingVector != 0) ) {\r
	110	//\r
	111	// more step needed - because relative address is handled differently between X64 and IA32.\r
	112	//\r
	113	AsmTransferControl16Address = (UINTN)AsmTransferControl16;\r
	114	AsmFixAddress16 = (UINT32)AsmTransferControl16Address;\r
	115	AsmJmpAddr32 = (UINT32)((Facs->FirmwareWakingVector & 0xF) \| ((Facs->FirmwareWakingVector & 0xFFFF0) << 12));\r
	116	}\r
be46cd5f	117	\r
	118	AsmDisablePaging64 (\r
	119	PeiS3ResumeState->ReturnCs,\r
	120	(UINT32)PeiS3ResumeState->ReturnEntryPoint,\r
	121	(UINT32)(UINTN)AcpiS3Context,\r
	122	(UINT32)(UINTN)PeiS3ResumeState,\r
	123	(UINT32)PeiS3ResumeState->ReturnStackPointer\r
	124	);\r
	125	} else {\r
	126	//\r
	127	// IA32 S3 Resume\r
	128	//\r
	129	DEBUG ((EFI_D_ERROR, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
	130	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl;\r
	131	\r
	132	SwitchStack (\r
	133	(SWITCH_STACK_ENTRY_POINT)(UINTN)PeiS3ResumeState->ReturnEntryPoint,\r
	134	(VOID *)(UINTN)AcpiS3Context,\r
	135	(VOID *)(UINTN)PeiS3ResumeState,\r
	136	(VOID *)(UINTN)PeiS3ResumeState->ReturnStackPointer\r
	137	);\r
	138	}\r
	139	\r
	140	//\r
	141	// Never run to here\r
	142	//\r
	143	CpuDeadLoop();\r
	144	return EFI_UNSUPPORTED;\r
	145	}\r
37623a5c	146	\r
	147	//\r
	148	// S3ResumePeim does not provide a way to jump back to itself, so resume to OS here directly\r
	149	//\r
be46cd5f	150	if (Facs->XFirmwareWakingVector != 0) {\r
	151	//\r
	152	// Switch to native waking vector\r
	153	//\r
	154	TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
	155	if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
	156	((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
	157	((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
	158	//\r
	159	// X64 long mode waking vector\r
	160	//\r
	161	DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
	162	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	163	SwitchStack (\r
	164	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
	165	NULL,\r
	166	NULL,\r
	167	(VOID *)(UINTN)TempStackTop\r
	168	);\r
	169	} else {\r
	170	// Unsupported for 32bit DXE, 64bit OS vector\r
	171	DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
	172	ASSERT (FALSE);\r
	173	}\r
	174	} else {\r
	175	//\r
	176	// IA32 protected mode waking vector (Page disabled)\r
	177	//\r
	178	DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
	179	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
	180	AsmDisablePaging64 (\r
	181	0x10,\r
	182	(UINT32)Facs->XFirmwareWakingVector,\r
	183	0,\r
	184	0,\r
	185	(UINT32)TempStackTop\r
	186	);\r
	187	} else {\r
	188	SwitchStack (\r
	189	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
	190	NULL,\r
	191	NULL,\r
	192	(VOID *)(UINTN)TempStackTop\r
	193	);\r
	194	}\r
	195	}\r
	196	} else {\r
	197	//\r
	198	// 16bit Realmode waking vector\r
	199	//\r
	200	DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
	201	AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
	202	}\r
	203	\r
	204	//\r
	205	// Never run to here\r
	206	//\r
	207	CpuDeadLoop();\r
	208	return EFI_UNSUPPORTED;\r
	209	}\r
59cc677c SZ	210	\r
	211	/**\r
	212	This is the Event notification function to reload BootScriptExecutor image\r
	213	to RESERVED mem and save it to LockBox.\r
	214	\r
	215	@param Event Pointer to this event\r
e3644786	216	@param Context Event handler private data \r
59cc677c SZ	217	**/\r
	218	VOID\r
	219	EFIAPI\r
	220	ReadyToLockEventNotify (\r
	221	IN EFI_EVENT Event,\r
	222	IN VOID *Context\r
	223	)\r
	224	{\r
	225	EFI_STATUS Status;\r
	226	VOID *Interface;\r
	227	UINT8 *Buffer;\r
	228	UINTN BufferSize;\r
	229	EFI_HANDLE NewImageHandle;\r
	230	UINTN Pages;\r
	231	EFI_PHYSICAL_ADDRESS FfsBuffer;\r
	232	PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
	233	\r
	234	Status = gBS->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid, NULL, &Interface);\r
	235	if (EFI_ERROR (Status)) {\r
	236	return;\r
	237	}\r
	238	\r
	239	//\r
	240	// A workaround: Here we install a dummy handle\r
	241	//\r
	242	NewImageHandle = NULL;\r
	243	Status = gBS->InstallProtocolInterface (\r
	244	&NewImageHandle,\r
	245	&gEfiCallerIdGuid,\r
	246	EFI_NATIVE_INTERFACE,\r
	247	NULL\r
	248	);\r
	249	ASSERT_EFI_ERROR (Status);\r
	250	\r
	251	//\r
	252	// Reload BootScriptExecutor image itself to RESERVED mem\r
	253	//\r
	254	Status = GetSectionFromAnyFv (\r
	255	&gEfiCallerIdGuid,\r
	256	EFI_SECTION_PE32,\r
	257	0,\r
	258	(VOID **) &Buffer,\r
	259	&BufferSize\r
	260	);\r
	261	ASSERT_EFI_ERROR (Status);\r
	262	ImageContext.Handle = Buffer;\r
	263	ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
	264	//\r
	265	// Get information about the image being loaded\r
	266	//\r
	267	Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
	268	ASSERT_EFI_ERROR (Status);\r
	269	Pages = EFI_SIZE_TO_PAGES(BufferSize + ImageContext.SectionAlignment);\r
	270	FfsBuffer = 0xFFFFFFFF;\r
	271	Status = gBS->AllocatePages (\r
	272	AllocateMaxAddress,\r
	273	EfiReservedMemoryType,\r
	274	Pages,\r
	275	&FfsBuffer\r
	276	);\r
	277	ASSERT_EFI_ERROR (Status);\r
	278	ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
	279	//\r
	280	// Align buffer on section boundry\r
281	//\r
282	ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
283	ImageContext.ImageAddress &= ~(ImageContext.SectionAlignment - 1);\r
284	//\r
285	// Load the image to our new buffer\r
286	//\r
287	Status = PeCoffLoaderLoadImage (&ImageContext);\r
288	ASSERT_EFI_ERROR (Status);\r
289	\r
290	//\r
291	// Relocate the image in our new buffer\r
292	//\r
293	Status = PeCoffLoaderRelocateImage (&ImageContext);\r
294	ASSERT_EFI_ERROR (Status);\r
295	\r
296	//\r
297	// Free the buffer allocated by ReadSection since the image has been relocated in the new buffer\r
298	//\r
299	gBS->FreePool (Buffer);\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, gST);\r
306	ASSERT_EFI_ERROR (Status);\r
307	\r
308	//\r
309	// Additional step for BootScript integrity\r
310	// Save BootScriptExecutor image\r
311	//\r
312	Status = SaveLockBox (\r
313	&mBootScriptExecutorImageGuid,\r
314	(VOID *)(UINTN)ImageContext.ImageAddress,\r
315	(UINTN)ImageContext.ImageSize\r
316	);\r
317	ASSERT_EFI_ERROR (Status);\r
318	\r
319	Status = SetLockBoxAttributes (&mBootScriptExecutorImageGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
320	ASSERT_EFI_ERROR (Status);\r
321	\r
322	gBS->CloseEvent (Event);\r
323	}\r
324	\r
be46cd5f	325	/**\r
	326	Entrypoint of Boot script exector driver, this function will be executed in\r
	327	normal boot phase and invoked by DXE dispatch.\r
	328	\r
	329	@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
	330	@param[in] SystemTable A pointer to the EFI System Table.\r
	331	\r
	332	@retval EFI_SUCCESS The entry point is executed successfully.\r
	333	@retval other Some error occurs when executing this entry point.\r
	334	**/\r
	335	EFI_STATUS\r
	336	EFIAPI\r
	337	BootScriptExecutorEntryPoint (\r
	338	IN EFI_HANDLE ImageHandle,\r
	339	IN EFI_SYSTEM_TABLE *SystemTable\r
	340	)\r
	341	{\r
be46cd5f	342	UINTN BufferSize;\r
be46cd5f	343	UINTN Pages;\r
be46cd5f	344	BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
	345	EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer;\r
	346	EFI_STATUS Status;\r
	347	VOID *DevicePath;\r
59cc677c SZ	348	EFI_EVENT ReadyToLockEvent;\r
	349	VOID *Registration;\r
	350	UINT32 RegEax;\r
	351	UINT32 RegEdx;\r
be46cd5f	352	\r
	353	//\r
	354	// Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry\r
	355	// point is loaded by DXE code which is the first time loaded. or else, it is already\r
	356	// be reloaded be itself.This is a work-around\r
	357	//\r
	358	Status = gBS->LocateProtocol (&gEfiCallerIdGuid, NULL, &DevicePath);\r
	359	if (EFI_ERROR (Status)) {\r
be46cd5f	360	//\r
59cc677c SZ	361	// Create ReadyToLock event to reload BootScriptExecutor image\r
59cc677c SZ	362	// to RESERVED mem and save it to LockBox.\r
be46cd5f	363	//\r
59cc677c SZ	364	ReadyToLockEvent = EfiCreateProtocolNotifyEvent (\r
	365	&gEfiDxeSmmReadyToLockProtocolGuid,\r
	366	TPL_NOTIFY,\r
	367	ReadyToLockEventNotify,\r
	368	NULL,\r
	369	&Registration\r
	370	);\r
	371	ASSERT (ReadyToLockEvent != NULL);\r
be46cd5f	372	} else {\r
be46cd5f	373	//\r
bad73446	374	// the entry point is invoked after reloading. following code only run in RESERVED mem\r
be46cd5f	375	//\r
59cc677c SZ	376	if (PcdGetBool(PcdUse1GPageTable)) {\r
	377	AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
	378	if (RegEax >= 0x80000001) {\r
	379	AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
	380	if ((RegEdx & BIT26) != 0) {\r
	381	mPage1GSupport = TRUE;\r
	382	}\r
	383	}\r
	384	}\r
	385	\r
be46cd5f	386	BufferSize = sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE);\r
	387	\r
	388	BootScriptExecutorBuffer = 0xFFFFFFFF;\r
	389	Pages = EFI_SIZE_TO_PAGES(BufferSize);\r
	390	Status = gBS->AllocatePages (\r
	391	AllocateMaxAddress,\r
bad73446	392	EfiReservedMemoryType,\r
be46cd5f	393	Pages,\r
	394	&BootScriptExecutorBuffer\r
	395	);\r
e0d216f6	396	ASSERT_EFI_ERROR (Status);\r
be46cd5f	397	\r
	398	EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *)(UINTN)BootScriptExecutorBuffer;\r
	399	EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = (UINTN) S3BootScriptExecutorEntryFunction ;\r
	400	\r
	401	Status = SaveLockBox (\r
	402	&gEfiBootScriptExecutorVariableGuid,\r
	403	&BootScriptExecutorBuffer,\r
	404	sizeof(BootScriptExecutorBuffer)\r
	405	);\r
	406	ASSERT_EFI_ERROR (Status);\r
	407	\r
	408	//\r
	409	// Additional step for BootScript integrity\r
	410	// Save BootScriptExecutor context\r
	411	//\r
	412	Status = SaveLockBox (\r
	413	&gEfiBootScriptExecutorContextGuid,\r
	414	EfiBootScriptExecutorVariable,\r
	415	sizeof(*EfiBootScriptExecutorVariable)\r
	416	);\r
	417	ASSERT_EFI_ERROR (Status);\r
	418	\r
	419	Status = SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
	420	ASSERT_EFI_ERROR (Status);\r
be46cd5f	421	}\r
	422	\r
	423	return EFI_SUCCESS;\r
	424	}\r
	425	\r