Update for NetworkPkg.
[mirror_edk2.git] / 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 - 2010, Intel Corporation. All rights reserved.<BR>
12 This program and the accompanying materials are licensed and made available under
13 the terms and conditions of the BSD License that accompanies this distribution.
14 The full text of the license may be found at
15 http://opensource.org/licenses/bsd-license.php.
16
17 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
18 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19
20 @par Revision Reference:
21 GUIDs defined in SmmCis spec version 0.9.
22
23 **/
24
25 #ifndef _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_
26 #define _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_
27
28 #define EFI_SMM_PEI_SMRAM_MEMORY_RESERVE \
29 { \
30 0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \
31 }
32
33 /**
34 * GUID specific data structure of HOB for reserving SMRAM regions.
35 *
36 * Inconsistent with specification here:
37 * EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.
38 * This inconsistency is kept in code in order for backward compatibility.
39 **/
40 typedef struct {
41 ///
42 /// Designates the number of possible regions in the system
43 /// that can be usable for SMRAM.
44 ///
45 /// Inconsistent with specification here:
46 /// In Framework SMM CIS 0.91 specification, it defines the field type as UINTN.
47 /// However, HOBs are supposed to be CPU neutral, so UINT32 should be used instead.
48 ///
49 UINT32 NumberOfSmmReservedRegions;
50 ///
51 /// Used throughout this protocol to describe the candidate
52 /// regions for SMRAM that are supported by this platform.
53 ///
54 EFI_SMRAM_DESCRIPTOR Descriptor[1];
55 } EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;
56
57 extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;
58
59 #endif
60