MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/ScriptExecute.h

   1 /** @file
   2   The header file for Boot Script Executer module.
   3
   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
   6
   7 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
   8
   9 This program and the accompanying materials
  10 are licensed and made available under the terms and conditions of the BSD License
  11 which accompanies this distribution.  The full text of the license may be found at
  12 http://opensource.org/licenses/bsd-license.php
  13
  14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  16
  17 **/
  18 #ifndef _BOOT_SCRIPT_EXECUTOR_H_
  19 #define _BOOT_SCRIPT_EXECUTOR_H_
  20
  21 #include <PiDxe.h>
  22
  23 #include <Library/BaseLib.h>
  24 #include <Library/UefiDriverEntryPoint.h>
  25 #include <Library/BaseMemoryLib.h>
  26 #include <Library/DebugLib.h>
  27 #include <Library/S3BootScriptLib.h>
  28 #include <Library/PeCoffLib.h>
  29 #include <Library/DxeServicesLib.h>
  30 #include <Library/UefiBootServicesTableLib.h>
  31 #include <Library/UefiRuntimeServicesTableLib.h>
  32 #include <Library/PcdLib.h>
  33 #include <Library/CacheMaintenanceLib.h>
  34 #include <Library/TimerLib.h>
  35 #include <Library/UefiLib.h>
  36 #include <Library/DebugAgentLib.h>
  37 #include <Library/LockBoxLib.h>
  38 #include <Library/CpuExceptionHandlerLib.h>
  39
  40 #include <Guid/AcpiS3Context.h>
  41 #include <Guid/BootScriptExecutorVariable.h>
  42 #include <Protocol/DxeSmmReadyToLock.h>
  43 #include <IndustryStandard/Acpi.h>
  44 /**
  45   a ASM function to transfer control to OS.
  46
  47   @param  S3WakingVector  The S3 waking up vector saved in ACPI Facs table
  48   @param  AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
  49 **/
  50 VOID
  51 AsmTransferControl (
  52   IN   UINT32           S3WakingVector,
  53   IN   UINT32           AcpiLowMemoryBase
  54   );
  55 /**
  56   a 32bit ASM function to transfer control to OS.
  57
  58   @param  S3WakingVector  The S3 waking up vector saved in ACPI Facs table
  59   @param  AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
  60 **/
  61 VOID
  62 AsmTransferControl32 (
  63   IN   UINT32           S3WakingVector,
  64   IN   UINT32           AcpiLowMemoryBase
  65   );
  66 /**
  67   a 16bit ASM function to transfer control to OS.
  68 **/
  69 VOID
  70 AsmTransferControl16 (
  71   VOID
  72   );
  73 /**
  74   Set a IDT entry for interrupt vector 3 for debug purpose.
  75
  76   @param  AcpiS3Context  a pointer to a structure of ACPI_S3_CONTEXT
  77
  78 **/
  79 VOID
  80 SetIdtEntry (
  81   IN ACPI_S3_CONTEXT     *AcpiS3Context
  82   );
  83
  84 extern UINT32 AsmFixAddress16;
  85 extern UINT32 AsmJmpAddr32;
  86 extern BOOLEAN mPage1GSupport;
  87
  88 #endif //_BOOT_SCRIPT_EXECUTOR_H_