IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h

   1 /** @file
   2   Definition of GUIDed HOB for reserving SMRAM regions.
   3
   4   This file defines:
   5   * the GUID used to identify the GUID HOB for reserving SMRAM regions.
   6   * the data structure of SMRAM descriptor to describe SMRAM candidate regions
   7   * values of state of SMRAM candidate regions
   8   * the GUID specific data structure of HOB for reserving SMRAM regions.
   9   This GUIDed HOB can be used to convey the existence of the T-SEG reservation and H-SEG usage
  10
  11 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
  12 SPDX-License-Identifier: BSD-2-Clause-Patent
  13
  14   @par Revision Reference:
  15   GUIDs defined in SmmCis spec version 0.9.
  16
  17 **/
  18
  19 #ifndef _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_
  20 #define _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_
  21
  22 #define EFI_SMM_PEI_SMRAM_MEMORY_RESERVE \
  23   { \
  24     0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \
  25   }
  26
  27 /**
  28 * GUID specific data structure of HOB for reserving SMRAM regions.
  29 *
  30 * Inconsistent with specification here:
  31 * EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.
  32 * This inconsistency is kept in code in order for backward compatibility.
  33 **/
  34 typedef struct {
  35   ///
  36   /// Designates the number of possible regions in the system
  37   /// that can be usable for SMRAM.
  38   ///
  39   /// Inconsistent with specification here:
  40   /// In Framework SMM CIS 0.91 specification, it defines the field type as UINTN.
  41   /// However, HOBs are supposed to be CPU neutral, so UINT32 should be used instead.
  42   ///
  43   UINT32                NumberOfSmmReservedRegions;
  44   ///
  45   /// Used throughout this protocol to describe the candidate
  46   /// regions for SMRAM that are supported by this platform.
  47   ///
  48   EFI_SMRAM_DESCRIPTOR  Descriptor[1];
  49 } EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;
  50
  51 extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;
  52
  53 #endif
  54