MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Guid / AcpiS3Context.h

/** @file\r
  Definitions for data structures used in S3 resume.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ACPI_S3_DATA_H_\r
#define _ACPI_S3_DATA_H_\r
\r
#include <Library/BaseLib.h>\r
\r
#define SMM_S3_RESUME_SMM_32 SIGNATURE_64 ('S','M','M','S','3','_','3','2')\r
#define SMM_S3_RESUME_SMM_64 SIGNATURE_64 ('S','M','M','S','3','_','6','4')\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT64                Signature;\r
  EFI_PHYSICAL_ADDRESS  SmmS3ResumeEntryPoint;\r
  EFI_PHYSICAL_ADDRESS  SmmS3StackBase;\r
  UINT64                SmmS3StackSize;\r
  UINT64                SmmS3Cr0;\r
  UINT64                SmmS3Cr3;\r
  UINT64                SmmS3Cr4;\r
  UINT16                ReturnCs;\r
  EFI_PHYSICAL_ADDRESS  ReturnEntryPoint;\r
  EFI_PHYSICAL_ADDRESS  ReturnContext1;\r
  EFI_PHYSICAL_ADDRESS  ReturnContext2;\r
  EFI_PHYSICAL_ADDRESS  ReturnStackPointer;\r
  EFI_PHYSICAL_ADDRESS  Smst;\r
} SMM_S3_RESUME_STATE;\r
\r
\r
typedef struct {\r
  EFI_PHYSICAL_ADDRESS  AcpiFacsTable;\r
  EFI_PHYSICAL_ADDRESS  IdtrProfile;\r
  EFI_PHYSICAL_ADDRESS  S3NvsPageTableAddress;\r
  EFI_PHYSICAL_ADDRESS  BootScriptStackBase;\r
  UINT64                BootScriptStackSize;\r
  EFI_PHYSICAL_ADDRESS  S3DebugBufferAddress;\r
} ACPI_S3_CONTEXT;\r
\r
typedef struct {\r
  UINT16                ReturnCs;\r
  UINT64                ReturnStatus;\r
  EFI_PHYSICAL_ADDRESS  ReturnEntryPoint;\r
  EFI_PHYSICAL_ADDRESS  ReturnStackPointer;\r
  EFI_PHYSICAL_ADDRESS  AsmTransferControl;\r
  IA32_DESCRIPTOR       Idtr;\r
} PEI_S3_RESUME_STATE;\r
\r
#pragma pack()\r
\r
#define EFI_ACPI_S3_CONTEXT_GUID \\r
  { \\r
    0xef98d3a, 0x3e33, 0x497a, {0xa4, 0x1, 0x77, 0xbe, 0x3e, 0xb7, 0x4f, 0x38} \\r
  }\r
\r
extern EFI_GUID gEfiAcpiS3ContextGuid;\r
\r
extern EFI_GUID gEfiAcpiVariableGuid;\r
\r
#endif\r