Remove IntelFrameworkModulePkg

[mirror_edk2.git] / IntelFrameworkPkg / Include / Guid / SmramMemoryReserve.h

/** @file\r
  Definition of GUIDed HOB for reserving SMRAM regions.\r
\r
  This file defines:\r
  * the GUID used to identify the GUID HOB for reserving SMRAM regions.\r
  * the data structure of SMRAM descriptor to describe SMRAM candidate regions\r
  * values of state of SMRAM candidate regions\r
  * the GUID specific data structure of HOB for reserving SMRAM regions.\r
  This GUIDed HOB can be used to convey the existence of the T-SEG reservation and H-SEG usage\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  GUIDs defined in SmmCis spec version 0.9.\r
\r
**/\r
\r
#ifndef _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_\r
#define _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_\r
\r
#define EFI_SMM_PEI_SMRAM_MEMORY_RESERVE \\r
  { \\r
    0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \\r
  }\r
\r
/**\r
* GUID specific data structure of HOB for reserving SMRAM regions.\r
*\r
* Inconsistent with specification here:\r
* EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.\r
* This inconsistency is kept in code in order for backward compatibility.\r
**/\r
typedef struct {\r
  ///\r
  /// Designates the number of possible regions in the system\r
  /// that can be usable for SMRAM.\r
  ///\r
  /// Inconsistent with specification here:\r
  /// In Framework SMM CIS 0.91 specification, it defines the field type as UINTN.\r
  /// However, HOBs are supposed to be CPU neutral, so UINT32 should be used instead.\r
  ///\r
  UINT32                NumberOfSmmReservedRegions;\r
  ///\r
  /// Used throughout this protocol to describe the candidate\r
  /// regions for SMRAM that are supported by this platform.\r
  ///\r
  EFI_SMRAM_DESCRIPTOR  Descriptor[1];\r
} EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;\r
\r
extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;\r
\r
#endif\r
\r