MdePkg/Include/Guid/SmramMemoryReserve.h

   1 /** @file
   2   This is a special GUID extension Hob to describe SMRAM memory 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
  10   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
  11   SPDX-License-Identifier: BSD-2-Clause-Patent
  12
  13   @par Revision Reference:
  14   GUIDs defined in PI SPEC version 1.5.
  15
  16 **/
  17
  18 #ifndef _SMRAM_MEMORY_RESERVE_H_
  19 #define _SMRAM_MEMORY_RESERVE_H_
  20
  21 #define EFI_SMM_SMRAM_MEMORY_GUID \
  22   { \
  23     0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \
  24   }
  25
  26 /**
  27 * The GUID extension hob is to describe SMRAM memory regions supported by the platform.
  28 **/
  29 typedef struct {
  30   ///
  31   /// Designates the number of possible regions in the system
  32   /// that can be usable for SMRAM.
  33   ///
  34   UINT32                NumberOfSmmReservedRegions;
  35   ///
  36   /// Used throughout this protocol to describe the candidate
  37   /// regions for SMRAM that are supported by this platform.
  38   ///
  39   EFI_SMRAM_DESCRIPTOR  Descriptor[1];
  40 } EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;
  41
  42 extern EFI_GUID gEfiSmmSmramMemoryGuid;
  43
  44 #endif
  45