Check the question value before call CHANGED. Only when question value has been chang...
[mirror_edk2.git] / MdePkg / Include / Uefi / UefiMultiPhase.h
CommitLineData
959ccb23 1/** @file\r
00edb218 2 This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.\r
959ccb23 3\r
ab0eecec 4Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
af2dc6a7 5This program and the accompanying materials are licensed and made available under \r
6the terms and conditions of the BSD License that accompanies this distribution. \r
7The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php. \r
9 \r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
959ccb23 12\r
959ccb23 13**/\r
14\r
15#ifndef __UEFI_MULTIPHASE_H__\r
16#define __UEFI_MULTIPHASE_H__\r
17\r
bd86cb02 18#include <Guid/WinCertificate.h>\r
8b13229b 19///\r
20/// Enumeration of memory types introduced in UEFI.\r
21/// \r
959ccb23 22typedef enum {\r
1bf79370
LG
23 ///\r
24 /// Not used.\r
25 ///\r
00edb218 26 EfiReservedMemoryType,\r
1bf79370
LG
27 ///\r
28 /// The code portions of a loaded application. \r
29 /// (Note that UEFI OS loaders are UEFI applications.)\r
30 ///\r
00edb218 31 EfiLoaderCode,\r
1bf79370
LG
32 ///\r
33 /// The data portions of a loaded application and the default data allocation\r
34 /// type used by an application to allocate pool memory.\r
35 ///\r
00edb218 36 EfiLoaderData,\r
1bf79370 37 ///\r
af2dc6a7 38 /// The code portions of a loaded Boot Services Driver.\r
1bf79370 39 ///\r
00edb218 40 EfiBootServicesCode,\r
1bf79370
LG
41 ///\r
42 /// The data portions of a loaded Boot Serves Driver, and the default data\r
43 /// allocation type used by a Boot Services Driver to allocate pool memory.\r
44 ///\r
00edb218 45 EfiBootServicesData,\r
1bf79370
LG
46 ///\r
47 /// The code portions of a loaded Runtime Services Driver.\r
48 ///\r
00edb218 49 EfiRuntimeServicesCode,\r
1bf79370
LG
50 ///\r
51 /// The data portions of a loaded Runtime Services Driver and the default\r
52 /// data allocation type used by a Runtime Services Driver to allocate pool memory.\r
53 ///\r
00edb218 54 EfiRuntimeServicesData,\r
1bf79370
LG
55 ///\r
56 /// Free (unallocated) memory.\r
57 ///\r
00edb218 58 EfiConventionalMemory,\r
1bf79370
LG
59 ///\r
60 /// Memory in which errors have been detected.\r
61 ///\r
00edb218 62 EfiUnusableMemory,\r
1bf79370
LG
63 ///\r
64 /// Memory that holds the ACPI tables.\r
65 ///\r
00edb218 66 EfiACPIReclaimMemory,\r
1bf79370
LG
67 ///\r
68 /// Address space reserved for use by the firmware.\r
69 ///\r
00edb218 70 EfiACPIMemoryNVS,\r
1bf79370
LG
71 ///\r
72 /// Used by system firmware to request that a memory-mapped IO region\r
73 /// be mapped by the OS to a virtual address so it can be accessed by EFI runtime services.\r
74 ///\r
00edb218 75 EfiMemoryMappedIO,\r
1bf79370
LG
76 ///\r
77 /// System memory-mapped IO region that is used to translate memory\r
78 /// cycles to IO cycles by the processor.\r
79 ///\r
00edb218 80 EfiMemoryMappedIOPortSpace,\r
1bf79370
LG
81 ///\r
82 /// Address space reserved by the firmware for code that is part of the processor.\r
83 ///\r
00edb218
A
84 EfiPalCode,\r
85 EfiMaxMemoryType\r
959ccb23 86} EFI_MEMORY_TYPE;\r
87\r
8b13229b 88///\r
89/// Data structure that precedes all of the standard EFI table types.\r
90/// \r
959ccb23 91typedef struct {\r
1bf79370
LG
92 ///\r
93 /// A 64-bit signature that identifies the type of table that follows.\r
94 /// Unique signatures have been generated for the EFI System Table,\r
95 /// the EFI Boot Services Table, and the EFI Runtime Services Table.\r
96 ///\r
00edb218 97 UINT64 Signature;\r
1bf79370
LG
98 ///\r
99 /// The revision of the EFI Specification to which this table\r
100 /// conforms. The upper 16 bits of this field contain the major\r
101 /// revision value, and the lower 16 bits contain the minor revision\r
102 /// value. The minor revision values are limited to the range of 00..99.\r
103 ///\r
00edb218 104 UINT32 Revision;\r
1bf79370
LG
105 ///\r
106 /// The size, in bytes, of the entire table including the EFI_TABLE_HEADER.\r
107 ///\r
00edb218 108 UINT32 HeaderSize;\r
1bf79370
LG
109 ///\r
110 /// The 32-bit CRC for the entire table. This value is computed by\r
111 /// setting this field to 0, and computing the 32-bit CRC for HeaderSize bytes.\r
112 ///\r
00edb218 113 UINT32 CRC32;\r
1bf79370
LG
114 ///\r
115 /// Reserved field that must be set to 0.\r
116 ///\r
00edb218 117 UINT32 Reserved;\r
959ccb23 118} EFI_TABLE_HEADER;\r
119\r
8b13229b 120///\r
121/// Attributes of variable.\r
122/// \r
ab0eecec 123#define EFI_VARIABLE_NON_VOLATILE 0x00000001\r
124#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
125#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004\r
8b13229b 126///\r
127/// This attribute is identified by the mnemonic 'HR' \r
128/// elsewhere in this specification.\r
129/// \r
ab0eecec 130#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008\r
131///\r
132/// Attributes of Authenticated Variable\r
133///\r
134#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010\r
135#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x00000020\r
136#define EFI_VARIABLE_APPEND_WRITE 0x00000040\r
137\r
959ccb23 138\r
3ed785e9 139/// \r
140/// AuthInfo is a WIN_CERTIFICATE using the wCertificateType\r
141/// WIN_CERTIFICATE_UEFI_GUID and the CertType\r
85560919 142/// EFI_CERT_TYPE_RSA2048_SHA256_GUID. If the attribute specifies\r
3ed785e9 143/// authenticated access, then the Data buffer should begin with an\r
144/// authentication descriptor prior to the data payload and DataSize\r
145/// should reflect the the data.and descriptor size. The caller\r
146/// shall digest the Monotonic Count value and the associated data\r
147/// for the variable update using the SHA-256 1-way hash algorithm.\r
148/// The ensuing the 32-byte digest will be signed using the private\r
149/// key associated w/ the public/private 2048-bit RSA key-pair. The\r
150/// WIN_CERTIFICATE shall be used to describe the signature of the\r
151/// Variable data *Data. In addition, the signature will also\r
af2dc6a7 152/// include the MonotonicCount value to guard against replay attacks.\r
3ed785e9 153/// \r
959ccb23 154typedef struct {\r
3ed785e9 155 ///\r
156 /// Included in the signature of \r
157 /// AuthInfo.Used to ensure freshness/no\r
158 /// replay. Incremented during each \r
159 /// "Write" access. \r
160 /// \r
00edb218 161 UINT64 MonotonicCount;\r
3ed785e9 162 ///\r
163 /// Provides the authorization for the variable \r
164 /// access. It is a signature across the \r
165 /// variable data and the Monotonic Count \r
166 /// value. Caller uses Private key that is \r
167 /// associated with a public key that has been \r
168 /// provisioned via the key exchange. \r
169 ///\r
00edb218 170 WIN_CERTIFICATE_UEFI_GUID AuthInfo;\r
959ccb23 171} EFI_VARIABLE_AUTHENTICATION;\r
172\r
ab0eecec 173///\r
174/// When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is \r
175/// set, then the Data buffer shall begin with an instance of a complete (and serialized)\r
176/// EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new \r
177/// variable value and DataSize shall reflect the combined size of the descriptor and the new \r
178/// variable value. The authentication descriptor is not part of the variable data and is not \r
179/// returned by subsequent calls to GetVariable().\r
180///\r
181typedef struct {\r
182 ///\r
183 /// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and \r
184 /// Pad2 shall be set to 0. This means that the time shall always be expressed in GMT.\r
185 ///\r
186 EFI_TIME TimeStamp;\r
187 /// \r
188 /// Only a CertType of EFI_CERT_TYPE_PKCS7_GUID is accepted.\r
189 ///\r
190 WIN_CERTIFICATE_UEFI_GUID AuthInfo;\r
191 } EFI_VARIABLE_AUTHENTICATION_2;\r
959ccb23 192\r
ab0eecec 193#endif\r