2 The header file for Boot Script Executer module.
4 This driver is dispatched by Dxe core and the driver will reload itself to ACPI reserved memory
5 in the entry point. The functionality is to interpret and restore the S3 boot script
7 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
8 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
10 SPDX-License-Identifier: BSD-2-Clause-Patent
14 #ifndef _BOOT_SCRIPT_EXECUTOR_H_
15 #define _BOOT_SCRIPT_EXECUTOR_H_
19 #include <Library/BaseLib.h>
20 #include <Library/UefiDriverEntryPoint.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/DebugLib.h>
23 #include <Library/S3BootScriptLib.h>
24 #include <Library/PeCoffLib.h>
25 #include <Library/DxeServicesLib.h>
26 #include <Library/UefiBootServicesTableLib.h>
27 #include <Library/UefiRuntimeServicesTableLib.h>
28 #include <Library/PcdLib.h>
29 #include <Library/CacheMaintenanceLib.h>
30 #include <Library/TimerLib.h>
31 #include <Library/UefiLib.h>
32 #include <Library/DebugAgentLib.h>
33 #include <Library/LockBoxLib.h>
34 #include <Library/CpuExceptionHandlerLib.h>
35 #include <Library/DevicePathLib.h>
36 #include <Library/DxeServicesTableLib.h>
38 #include <Guid/AcpiS3Context.h>
39 #include <Guid/BootScriptExecutorVariable.h>
40 #include <Guid/MemoryProfile.h>
42 #include <Protocol/DxeSmmReadyToLock.h>
43 #include <IndustryStandard/Acpi.h>
45 #define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull
48 a ASM function to transfer control to OS.
50 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table
51 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
55 IN UINT32 S3WakingVector
,
56 IN UINT32 AcpiLowMemoryBase
60 a 32bit ASM function to transfer control to OS.
62 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table
63 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
66 AsmTransferControl32 (
67 IN UINT32 S3WakingVector
,
68 IN UINT32 AcpiLowMemoryBase
72 a 16bit ASM function to transfer control to OS.
75 AsmTransferControl16 (
80 Set a IDT entry for interrupt vector 3 for debug purpose.
82 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
87 IN ACPI_S3_CONTEXT
*AcpiS3Context
90 extern UINT32 AsmFixAddress16
;
91 extern UINT32 AsmJmpAddr32
;
92 extern BOOLEAN mPage1GSupport
;
93 extern UINT64 mAddressEncMask
;
95 #endif //_BOOT_SCRIPT_EXECUTOR_H_