[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 - 2011, 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_PHYSICAL_ADDRESS  mPerfDataMemAddress;\r
UINT64                mS3BootScriptEntryTick;\r
UINT64                mScriptStartTick;\r
UINT64                mScriptEndTick;\r
\r
EFI_GUID              mBootScriptExecutorImageGuid = {\r
  0x9a8d3433, 0x9fe8, 0x42b6, 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b\r
};\r
\r
/**\r
  The event callback is used to get the base address of boot performance data structure on\r
  LegacyBoot event and ExitBootServices event.\r
\r
  @param  Event    The event handle.\r
  @param  Context  The event context.\r
\r
**/\r
VOID\r
EFIAPI\r
OnBootEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  EFI_STATUS Status;\r
  UINTN      VarSize;\r
\r
  VarSize = sizeof (EFI_PHYSICAL_ADDRESS);\r
  Status = gRT->GetVariable (\r
                  L"PerfDataMemAddr",\r
                  &gPerformanceProtocolGuid,\r
                  NULL,\r
                  &VarSize,\r
                  &mPerfDataMemAddress\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    mPerfDataMemAddress = 0;\r
  }\r
}\r
\r
/**\r
  Record S3 Script execution time and adjust total S3 resume time for script running.\r
**/\r
VOID\r
WriteToOsS3PerformanceData (\r
  VOID\r
  )\r
{\r
  UINT64               Ticker;\r
  UINT64               StartValue;\r
  UINT64               EndValue;\r
  UINT64               Freq;\r
  UINT64               ScriptExecuteTicks;\r
  PERF_HEADER          *PerfHeader;\r
  PERF_DATA            *PerfData;\r
\r
  Ticker = GetPerformanceCounter ();\r
\r
  PerfHeader = (PERF_HEADER *)(UINTN)mPerfDataMemAddress;\r
  if (PerfHeader == NULL) {\r
    return;\r
  }\r
\r
  Freq   = GetPerformanceCounterProperties (&StartValue, &EndValue);\r
  Freq   = DivU64x32 (Freq, 1000);\r
\r
  if (EndValue >= StartValue) {\r
    ScriptExecuteTicks = mScriptEndTick - mScriptStartTick;\r
    PerfHeader->S3Resume += Ticker - mS3BootScriptEntryTick;\r
  } else {\r
    ScriptExecuteTicks = mScriptStartTick - mScriptEndTick;\r
    PerfHeader->S3Resume += mS3BootScriptEntryTick - Ticker;\r
  }\r
  if (PerfHeader->S3EntryNum < PERF_PEI_ENTRY_MAX_NUM) {\r
    PerfData = &PerfHeader->S3Entry[PerfHeader->S3EntryNum];\r
    PerfData->Duration = (UINT32) DivU64x32 (ScriptExecuteTicks, (UINT32) Freq);;\r
    AsciiStrnCpy (PerfData->Token, "ScriptExec", PERF_TOKEN_LENGTH);\r
    PerfHeader->S3EntryNum++;\r
  }\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
\r
  PERF_CODE (\r
    mS3BootScriptEntryTick = GetPerformanceCounter ();\r
    );\r
\r
  //\r
  // Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
  //\r
  SaveAndSetDebugTimerInterrupt (FALSE);\r
\r
  //\r
  // Restore IDT for debug\r
  //\r
  SetIdtEntry (AcpiS3Context);\r
\r
  //\r
  // Initialize Debug Agent to support source level debug in S3 path.\r
  //\r
  InitializeDebugAgent (DEBUG_AGENT_INIT_S3, NULL, NULL);\r
\r
  //\r
  // Because not install BootScriptExecute PPI(used just in this module), So just pass NULL\r
  // for that parameter.\r
  //\r
  PERF_CODE (\r
    mScriptStartTick = GetPerformanceCounter ();\r
    );\r
  Status = S3BootScriptExecute ();\r
  PERF_CODE (\r
    mScriptEndTick = GetPerformanceCounter ();\r
    );\r
  if (EFI_ERROR (Status)) {\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
  if ((Facs == NULL) ||\r
      (Facs->Signature != EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
      ((Facs->FirmwareWakingVector == 0) && (Facs->XFirmwareWakingVector == 0)) ) {\r
    CpuDeadLoop();\r
    return EFI_INVALID_PARAMETER;\r
  }\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
      //\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
      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
  PERF_CODE (\r
    WriteToOsS3PerformanceData ();\r
    );\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
      PERF_CODE (\r
        EFI_EVENT Event;\r
\r
        gBS->CreateEventEx (\r
              EVT_NOTIFY_SIGNAL,\r
              TPL_NOTIFY,\r
              OnBootEvent,\r
              NULL,\r
              &gEfiEventExitBootServicesGuid,\r
              &Event\r
              );\r
\r
        EfiCreateEventLegacyBootEx(\r
          TPL_NOTIFY,\r
          OnBootEvent,\r
          NULL,\r
          &Event\r
          );\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
	7	Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
	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
	21	EFI_PHYSICAL_ADDRESS mPerfDataMemAddress;\r
	22	UINT64 mS3BootScriptEntryTick;\r
	23	UINT64 mScriptStartTick;\r
	24	UINT64 mScriptEndTick;\r
	25	\r
	26	EFI_GUID mBootScriptExecutorImageGuid = {\r
	27	0x9a8d3433, 0x9fe8, 0x42b6, 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b\r
	28	};\r
	29	\r
	30	/**\r
	31	The event callback is used to get the base address of boot performance data structure on\r
	32	LegacyBoot event and ExitBootServices event.\r
	33	\r
	34	@param Event The event handle.\r
	35	@param Context The event context.\r
	36	\r
	37	**/\r
	38	VOID\r
	39	EFIAPI\r
	40	OnBootEvent (\r
	41	IN EFI_EVENT Event,\r
	42	IN VOID *Context\r
	43	)\r
	44	{\r
	45	EFI_STATUS Status;\r
	46	UINTN VarSize;\r
	47	\r
	48	VarSize = sizeof (EFI_PHYSICAL_ADDRESS);\r
	49	Status = gRT->GetVariable (\r
	50	L"PerfDataMemAddr",\r
	51	&gPerformanceProtocolGuid,\r
	52	NULL,\r
	53	&VarSize,\r
	54	&mPerfDataMemAddress\r
	55	);\r
	56	if (EFI_ERROR (Status)) {\r
	57	mPerfDataMemAddress = 0;\r
	58	}\r
	59	}\r
	60	\r
	61	/**\r
	62	Record S3 Script execution time and adjust total S3 resume time for script running.\r
	63	**/\r
	64	VOID\r
65	WriteToOsS3PerformanceData (\r
66	VOID\r
67	)\r
68	{\r
69	UINT64 Ticker;\r
70	UINT64 StartValue;\r
71	UINT64 EndValue;\r
72	UINT64 Freq;\r
73	UINT64 ScriptExecuteTicks;\r
74	PERF_HEADER *PerfHeader;\r
75	PERF_DATA *PerfData;\r
76	\r
77	Ticker = GetPerformanceCounter ();\r
78	\r
79	PerfHeader = (PERF_HEADER *)(UINTN)mPerfDataMemAddress;\r
80	if (PerfHeader == NULL) {\r
81	return;\r
82	}\r
83	\r
84	Freq = GetPerformanceCounterProperties (&StartValue, &EndValue);\r
85	Freq = DivU64x32 (Freq, 1000);\r
86	\r
87	if (EndValue >= StartValue) {\r
88	ScriptExecuteTicks = mScriptEndTick - mScriptStartTick;\r
89	PerfHeader->S3Resume += Ticker - mS3BootScriptEntryTick;\r
90	} else {\r
91	ScriptExecuteTicks = mScriptStartTick - mScriptEndTick;\r
92	PerfHeader->S3Resume += mS3BootScriptEntryTick - Ticker;\r
93	}\r
94	if (PerfHeader->S3EntryNum < PERF_PEI_ENTRY_MAX_NUM) {\r
95	PerfData = &PerfHeader->S3Entry[PerfHeader->S3EntryNum];\r
96	PerfData->Duration = (UINT32) DivU64x32 (ScriptExecuteTicks, (UINT32) Freq);;\r
97	AsciiStrnCpy (PerfData->Token, "ScriptExec", PERF_TOKEN_LENGTH);\r
98	PerfHeader->S3EntryNum++;\r
99	}\r
100	}\r
101	\r
102	/**\r
103	Entry function of Boot script exector. This function will be executed in\r
104	S3 boot path.\r
105	This function should not return, because it is invoked by switch stack.\r
106	\r
107	@param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
108	@param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
109	\r
110	@retval EFI_INVALID_PARAMETER - OS waking vector not found\r
111	@retval EFI_UNSUPPORTED - something wrong when we resume to OS\r
112	**/\r
113	EFI_STATUS\r
114	EFIAPI\r
115	S3BootScriptExecutorEntryFunction (\r
116	IN ACPI_S3_CONTEXT *AcpiS3Context,\r
117	IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
118	)\r
119	{\r
120	EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
121	EFI_STATUS Status;\r
122	UINTN TempStackTop;\r
123	UINTN TempStack[0x10];\r
124	UINTN AsmTransferControl16Address;\r
125	\r
126	PERF_CODE (\r
127	mS3BootScriptEntryTick = GetPerformanceCounter ();\r
128	);\r
129	\r
130	//\r
131	// Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
132	//\r
133	SaveAndSetDebugTimerInterrupt (FALSE);\r
134	\r
135	//\r
136	// Restore IDT for debug\r
137	//\r
138	SetIdtEntry (AcpiS3Context);\r
139	\r
140	//\r
141	// Initialize Debug Agent to support source level debug in S3 path.\r
142	//\r
143	InitializeDebugAgent (DEBUG_AGENT_INIT_S3, NULL, NULL);\r
144	\r
145	//\r
146	// Because not install BootScriptExecute PPI(used just in this module), So just pass NULL\r
147	// for that parameter.\r
148	//\r
149	PERF_CODE (\r
150	mScriptStartTick = GetPerformanceCounter ();\r
151	);\r
152	Status = S3BootScriptExecute ();\r
153	PERF_CODE (\r
154	mScriptEndTick = GetPerformanceCounter ();\r
155	);\r
156	if (EFI_ERROR (Status)) {\r
157	return Status;\r
158	}\r
159	\r
160	AsmWbinvd ();\r
161	\r
162	//\r
163	// Get ACPI Table Address\r
164	//\r
165	Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
166	\r
167	if ((Facs == NULL) \|\|\r
168	(Facs->Signature != EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) \|\|\r
169	((Facs->FirmwareWakingVector == 0) && (Facs->XFirmwareWakingVector == 0)) ) {\r
170	CpuDeadLoop();\r
171	return EFI_INVALID_PARAMETER;\r
172	}\r
173	\r
174	//\r
175	// We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.\r
176	//\r
177	if (PeiS3ResumeState != 0) {\r
178	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
179	//\r
180	// X64 S3 Resume\r
181	//\r
182	DEBUG ((EFI_D_ERROR, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));\r
183	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl32;\r
184	\r
185	//\r
186	// more step needed - because relative address is handled differently between X64 and IA32.\r
187	//\r
188	AsmTransferControl16Address = (UINTN)AsmTransferControl16;\r
189	AsmFixAddress16 = (UINT32)AsmTransferControl16Address;\r
190	AsmJmpAddr32 = (UINT32)((Facs->FirmwareWakingVector & 0xF) \| ((Facs->FirmwareWakingVector & 0xFFFF0) << 12));\r
191	\r
192	AsmDisablePaging64 (\r
193	PeiS3ResumeState->ReturnCs,\r
194	(UINT32)PeiS3ResumeState->ReturnEntryPoint,\r
195	(UINT32)(UINTN)AcpiS3Context,\r
196	(UINT32)(UINTN)PeiS3ResumeState,\r
197	(UINT32)PeiS3ResumeState->ReturnStackPointer\r
198	);\r
199	} else {\r
200	//\r
201	// IA32 S3 Resume\r
202	//\r
203	DEBUG ((EFI_D_ERROR, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
204	PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl;\r
205	\r
206	SwitchStack (\r
207	(SWITCH_STACK_ENTRY_POINT)(UINTN)PeiS3ResumeState->ReturnEntryPoint,\r
208	(VOID *)(UINTN)AcpiS3Context,\r
209	(VOID *)(UINTN)PeiS3ResumeState,\r
210	(VOID *)(UINTN)PeiS3ResumeState->ReturnStackPointer\r
211	);\r
212	}\r
213	\r
214	//\r
215	// Never run to here\r
216	//\r
217	CpuDeadLoop();\r
218	return EFI_UNSUPPORTED;\r
219	}\r
220	\r
221	PERF_CODE (\r
222	WriteToOsS3PerformanceData ();\r
223	);\r
224	\r
225	if (Facs->XFirmwareWakingVector != 0) {\r
226	//\r
227	// Switch to native waking vector\r
228	//\r
229	TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
230	if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
231	((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
232	((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
233	//\r
234	// X64 long mode waking vector\r
235	//\r
236	DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
237	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
238	SwitchStack (\r
239	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
240	NULL,\r
241	NULL,\r
242	(VOID *)(UINTN)TempStackTop\r
243	);\r
244	} else {\r
245	// Unsupported for 32bit DXE, 64bit OS vector\r
246	DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
247	ASSERT (FALSE);\r
248	}\r
249	} else {\r
250	//\r
251	// IA32 protected mode waking vector (Page disabled)\r
252	//\r
253	DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
254	if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
255	AsmDisablePaging64 (\r
256	0x10,\r
257	(UINT32)Facs->XFirmwareWakingVector,\r
258	0,\r
259	0,\r
260	(UINT32)TempStackTop\r
261	);\r
262	} else {\r
263	SwitchStack (\r
264	(SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
265	NULL,\r
266	NULL,\r
267	(VOID *)(UINTN)TempStackTop\r
268	);\r
269	}\r
270	}\r
271	} else {\r
272	//\r
273	// 16bit Realmode waking vector\r
274	//\r
275	DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
276	AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
277	}\r
278	\r
279	//\r
280	// Never run to here\r
281	//\r
282	CpuDeadLoop();\r
283	return EFI_UNSUPPORTED;\r
284	}\r
285	/**\r
286	Entrypoint of Boot script exector driver, this function will be executed in\r
287	normal boot phase and invoked by DXE dispatch.\r
288	\r
289	@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
290	@param[in] SystemTable A pointer to the EFI System Table.\r
291	\r
292	@retval EFI_SUCCESS The entry point is executed successfully.\r
293	@retval other Some error occurs when executing this entry point.\r
294	**/\r
295	EFI_STATUS\r
296	EFIAPI\r
297	BootScriptExecutorEntryPoint (\r
298	IN EFI_HANDLE ImageHandle,\r
299	IN EFI_SYSTEM_TABLE *SystemTable\r
300	)\r
301	{\r
302	UINT8 *Buffer;\r
303	UINTN BufferSize;\r
304	UINTN Pages;\r
305	EFI_PHYSICAL_ADDRESS FfsBuffer;\r
306	PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
307	BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
308	EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer;\r
309	EFI_STATUS Status;\r
310	VOID *DevicePath;\r
311	EFI_HANDLE NewImageHandle;\r
312	\r
313	//\r
314	// Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry\r
315	// point is loaded by DXE code which is the first time loaded. or else, it is already\r
316	// be reloaded be itself.This is a work-around\r
317	//\r
318	Status = gBS->LocateProtocol (&gEfiCallerIdGuid, NULL, &DevicePath);\r
319	if (EFI_ERROR (Status)) {\r
320	\r
321	//\r
322	// This is the first-time loaded by DXE core. reload itself to NVS mem\r
323	//\r
324	//\r
325	// A workarouond: Here we install a dummy handle\r
326	//\r
327	NewImageHandle = NULL;\r
328	Status = gBS->InstallProtocolInterface (\r
329	&NewImageHandle,\r
330	&gEfiCallerIdGuid,\r
331	EFI_NATIVE_INTERFACE,\r
332	NULL\r
333	);\r
334	\r
335	Status = GetSectionFromAnyFv (\r
336	&gEfiCallerIdGuid,\r
337	EFI_SECTION_PE32,\r
338	0,\r
339	(VOID **) &Buffer,\r
340	&BufferSize\r
341	);\r
342	ImageContext.Handle = Buffer;\r
343	ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
344	//\r
345	// Get information about the image being loaded\r
346	//\r
347	Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
348	if (EFI_ERROR (Status)) {\r
349	return Status;\r
350	}\r
351	Pages = EFI_SIZE_TO_PAGES(BufferSize + ImageContext.SectionAlignment);\r
352	FfsBuffer = 0xFFFFFFFF;\r
353	Status = gBS->AllocatePages (\r
354	AllocateMaxAddress,\r
355	EfiACPIMemoryNVS,\r
356	Pages,\r
357	&FfsBuffer\r
358	);\r
359	if (EFI_ERROR (Status)) {\r
360	return EFI_OUT_OF_RESOURCES;\r
361	}\r
362	ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
363	//\r
364	// Align buffer on section boundry\r
365	//\r
366	ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
367	ImageContext.ImageAddress &= ~(ImageContext.SectionAlignment - 1);\r
368	//\r
369	// Load the image to our new buffer\r
370	//\r
371	Status = PeCoffLoaderLoadImage (&ImageContext);\r
372	if (EFI_ERROR (Status)) {\r
373	gBS->FreePages (FfsBuffer, Pages);\r
374	return Status;\r
375	}\r
376	\r
377	//\r
378	// Relocate the image in our new buffer\r
379	//\r
380	Status = PeCoffLoaderRelocateImage (&ImageContext);\r
381	\r
382	if (EFI_ERROR (Status)) {\r
383	PeCoffLoaderUnloadImage (&ImageContext);\r
384	gBS->FreePages (FfsBuffer, Pages);\r
385	return Status;\r
386	}\r
387	//\r
388	// Flush the instruction cache so the image data is written before we execute it\r
389	//\r
390	InvalidateInstructionCacheRange ((VOID *)(UINTN)ImageContext.ImageAddress, (UINTN)ImageContext.ImageSize);\r
391	Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint)) (NewImageHandle, SystemTable);\r
392	if (EFI_ERROR (Status)) {\r
393	gBS->FreePages (FfsBuffer, Pages);\r
394	return Status;\r
395	}\r
396	//\r
397	// Additional step for BootScript integrity\r
398	// Save BootScriptExecutor image\r
399	//\r
400	Status = SaveLockBox (\r
401	&mBootScriptExecutorImageGuid,\r
402	(VOID *)(UINTN)ImageContext.ImageAddress,\r
403	(UINTN)ImageContext.ImageSize\r
404	);\r
405	ASSERT_EFI_ERROR (Status);\r
406	\r
407	Status = SetLockBoxAttributes (&mBootScriptExecutorImageGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
408	ASSERT_EFI_ERROR (Status);\r
409	\r
410	} else {\r
411	//\r
412	// the entry point is invoked after reloading. following code only run in ACPI NVS\r
413	//\r
414	BufferSize = sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE);\r
415	\r
416	BootScriptExecutorBuffer = 0xFFFFFFFF;\r
417	Pages = EFI_SIZE_TO_PAGES(BufferSize);\r
418	Status = gBS->AllocatePages (\r
419	AllocateMaxAddress,\r
420	EfiACPIMemoryNVS,\r
421	Pages,\r
422	&BootScriptExecutorBuffer\r
423	);\r
424	if (EFI_ERROR (Status)) {\r
425	return EFI_OUT_OF_RESOURCES;\r
426	}\r
427	\r
428	EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *)(UINTN)BootScriptExecutorBuffer;\r
429	EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = (UINTN) S3BootScriptExecutorEntryFunction ;\r
430	\r
431	Status = SaveLockBox (\r
432	&gEfiBootScriptExecutorVariableGuid,\r
433	&BootScriptExecutorBuffer,\r
434	sizeof(BootScriptExecutorBuffer)\r
435	);\r
436	ASSERT_EFI_ERROR (Status);\r
437	\r
438	//\r
439	// Additional step for BootScript integrity\r
440	// Save BootScriptExecutor context\r
441	//\r
442	Status = SaveLockBox (\r
443	&gEfiBootScriptExecutorContextGuid,\r
444	EfiBootScriptExecutorVariable,\r
445	sizeof(*EfiBootScriptExecutorVariable)\r
446	);\r
447	ASSERT_EFI_ERROR (Status);\r
448	\r
449	Status = SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
450	ASSERT_EFI_ERROR (Status);\r
451	\r
452	PERF_CODE (\r
453	EFI_EVENT Event;\r
454	\r
455	gBS->CreateEventEx (\r
456	EVT_NOTIFY_SIGNAL,\r
457	TPL_NOTIFY,\r
458	OnBootEvent,\r
459	NULL,\r
460	&gEfiEventExitBootServicesGuid,\r
461	&Event\r
462	);\r
463	\r
464	EfiCreateEventLegacyBootEx(\r
465	TPL_NOTIFY,\r
466	OnBootEvent,\r
467	NULL,\r
468	&Event\r
469	);\r
470	);\r
471	}\r
472	\r
473	return EFI_SUCCESS;\r
474	}\r
475	\r
476	\r
477	\r