StandaloneMmPkg/HobLib: Add HOB Library for management mode.
[mirror_edk2.git] / StandaloneMmPkg / Include / Guid / MmramMemoryReserve.h
1 /** @file
2 Definition of GUIDed HOB for reserving MMRAM regions.
3
4 This file defines:
5 * the GUID used to identify the GUID HOB for reserving MMRAM regions.
6 * the data structure of MMRAM descriptor to describe MMRAM candidate regions
7 * values of state of MMRAM candidate regions
8 * the GUID specific data structure of HOB for reserving MMRAM 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 Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>
13
14 This program and the accompanying materials are licensed and made available under
15 the terms and conditions of the BSD License that accompanies this distribution.
16 The full text of the license may be found at
17 http://opensource.org/licenses/bsd-license.php.
18
19 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
20 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21
22 @par Revision Reference:
23 GUIDs defined in MmCis spec version 0.9.
24
25 **/
26
27 #ifndef _EFI_MM_PEI_MMRAM_MEMORY_RESERVE_H_
28 #define _EFI_MM_PEI_MMRAM_MEMORY_RESERVE_H_
29
30 #define EFI_MM_PEI_MMRAM_MEMORY_RESERVE \
31 { \
32 0x0703f912, 0xbf8d, 0x4e2a, {0xbe, 0x07, 0xab, 0x27, 0x25, 0x25, 0xc5, 0x92 } \
33 }
34
35 /**
36 * GUID specific data structure of HOB for reserving MMRAM regions.
37 *
38 * Inconsistent with specification here:
39 * EFI_HOB_MMRAM_DESCRIPTOR_BLOCK has been changed to EFI_MMRAM_HOB_DESCRIPTOR_BLOCK.
40 * This inconsistency is kept in code in order for backward compatibility.
41 **/
42 typedef struct {
43 ///
44 /// Designates the number of possible regions in the system
45 /// that can be usable for MMRAM.
46 ///
47 /// Inconsistent with specification here:
48 /// In Framework MM CIS 0.91 specification, it defines the field type as UINTN.
49 /// However, HOBs are supposed to be CPU neutral, so UINT32 should be used instead.
50 ///
51 UINT32 NumberOfMmReservedRegions;
52 ///
53 /// Used throughout this protocol to describe the candidate
54 /// regions for MMRAM that are supported by this platform.
55 ///
56 EFI_MMRAM_DESCRIPTOR Descriptor[1];
57 } EFI_MMRAM_HOB_DESCRIPTOR_BLOCK;
58
59 extern EFI_GUID gEfiMmPeiSmramMemoryReserveGuid;
60
61 #endif
62