]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
Remove unnecessary FRAMEWORK_ prefix in IntelFrameworkPkg definitions for those defin...
[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 - 2009, Intel Corporation
12 All rights reserved. This program and the accompanying materials
13 are licensed and made available under the terms and conditions of the BSD License
14 which accompanies this distribution. 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 /// Describes the candidate regions for SMRAM that are
35 /// supported by this platform.
36 ///
37 typedef struct {
38 EFI_PHYSICAL_ADDRESS PhysicalStart; ///< Designates the physical address of the SMRAM in memory.
39 EFI_PHYSICAL_ADDRESS CpuStart; ///< Designates the address of the SMRAM, as seen by software executing on the processors.
40 UINT64 PhysicalSize; ///< Describes the number of bytes in the SMRAM region.
41 UINT64 RegionState; ///< Describes the accessibility attributes of the SMRAM.
42 } EFI_SMRAM_DESCRIPTOR;
43
44 ///
45 /// Definition of SMRAM states, used as value for EFI_SMRAM_DESCRIPTOR.RegionState.
46 ///@{
47 #define EFI_SMRAM_OPEN 0x00000001
48 #define EFI_SMRAM_CLOSED 0x00000002
49 #define EFI_SMRAM_LOCKED 0x00000004
50 #define EFI_CACHEABLE 0x00000008
51 #define EFI_ALLOCATED 0x00000010
52 ///@}
53
54 /**
55 * GUID specific data structure of HOB for reserving SMRAM regions.
56 *
57 * Inconsistent with specification here:
58 * EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.
59 * This inconsistency is kept in code in order for backward compatibility.
60 **/
61 typedef struct {
62 ///
63 /// Designates the number of possible regions in the system
64 /// that can be usable for SMRAM.
65 ///
66 UINTN NumberOfSmmReservedRegions;
67 ///
68 /// Used throughout this protocol to describe the candidate
69 /// regions for SMRAM that are supported by this platform.
70 ///
71 EFI_SMRAM_DESCRIPTOR Descriptor[1];
72 } EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;
73
74 extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;
75
76 #endif
77