]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/UefiTcgPlatform.h
SecurityPkg: TCG Add more Event type
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / UefiTcgPlatform.h
CommitLineData
c311f86b 1/** @file\r
267669ba
LG
2 TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final\r
3\r
9095d37b 4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
9df063a0 5 This program and the accompanying materials\r
267669ba
LG
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef __UEFI_TCG_PLATFORM_H__\r
22a25d24 16#define __UEFI_TCG_PLATFORM_H__\r
267669ba
LG
17\r
18#include <IndustryStandard/Tpm12.h>\r
59b226d6 19#include <IndustryStandard/Tpm20.h>\r
a979fca9 20#include <Uefi.h>\r
1fd83dd2 21\r
267669ba
LG
22//\r
23// Standard event types\r
24//\r
4187f79c 25#define EV_PREBOOT_CERT ((TCG_EVENTTYPE) 0x00000000)\r
267669ba 26#define EV_POST_CODE ((TCG_EVENTTYPE) 0x00000001)\r
59b226d6 27#define EV_NO_ACTION ((TCG_EVENTTYPE) 0x00000003)\r
267669ba 28#define EV_SEPARATOR ((TCG_EVENTTYPE) 0x00000004)\r
4187f79c 29#define EV_ACTION ((TCG_EVENTTYPE) 0x00000005)\r
267669ba
LG
30#define EV_S_CRTM_CONTENTS ((TCG_EVENTTYPE) 0x00000007)\r
31#define EV_S_CRTM_VERSION ((TCG_EVENTTYPE) 0x00000008)\r
04a89420 32#define EV_CPU_MICROCODE ((TCG_EVENTTYPE) 0x00000009)\r
4187f79c 33#define EV_PLATFORM_CONFIG_FLAGS ((TCG_EVENTTYPE) 0x0000000A)\r
f5a859d6 34#define EV_TABLE_OF_DEVICES ((TCG_EVENTTYPE) 0x0000000B)\r
4187f79c
ZC
35#define EV_COMPACT_HASH ((TCG_EVENTTYPE) 0x0000000C)\r
36#define EV_NONHOST_CODE ((TCG_EVENTTYPE) 0x0000000F)\r
37#define EV_NONHOST_CONFIG ((TCG_EVENTTYPE) 0x00000010)\r
38#define EV_NONHOST_INFO ((TCG_EVENTTYPE) 0x00000011)\r
39#define EV_OMIT_BOOT_DEVICE_EVENTS ((TCG_EVENTTYPE) 0x00000012)\r
267669ba
LG
40\r
41//\r
42// EFI specific event types\r
43//\r
44#define EV_EFI_EVENT_BASE ((TCG_EVENTTYPE) 0x80000000)\r
45#define EV_EFI_VARIABLE_DRIVER_CONFIG (EV_EFI_EVENT_BASE + 1)\r
46#define EV_EFI_VARIABLE_BOOT (EV_EFI_EVENT_BASE + 2)\r
47#define EV_EFI_BOOT_SERVICES_APPLICATION (EV_EFI_EVENT_BASE + 3)\r
48#define EV_EFI_BOOT_SERVICES_DRIVER (EV_EFI_EVENT_BASE + 4)\r
49#define EV_EFI_RUNTIME_SERVICES_DRIVER (EV_EFI_EVENT_BASE + 5)\r
50#define EV_EFI_GPT_EVENT (EV_EFI_EVENT_BASE + 6)\r
51#define EV_EFI_ACTION (EV_EFI_EVENT_BASE + 7)\r
52#define EV_EFI_PLATFORM_FIRMWARE_BLOB (EV_EFI_EVENT_BASE + 8)\r
53#define EV_EFI_HANDOFF_TABLES (EV_EFI_EVENT_BASE + 9)\r
4187f79c 54#define EV_EFI_HCRTM_EVENT (EV_EFI_EVENT_BASE + 0x10)\r
59b226d6 55#define EV_EFI_VARIABLE_AUTHORITY (EV_EFI_EVENT_BASE + 0xE0)\r
267669ba 56\r
267669ba
LG
57#define EFI_CALLING_EFI_APPLICATION \\r
58 "Calling EFI Application from Boot Option"\r
59#define EFI_RETURNING_FROM_EFI_APPLICATOIN \\r
60 "Returning from EFI Application from Boot Option"\r
61#define EFI_EXIT_BOOT_SERVICES_INVOCATION \\r
62 "Exit Boot Services Invocation"\r
63#define EFI_EXIT_BOOT_SERVICES_FAILED \\r
64 "Exit Boot Services Returned with Failure"\r
65#define EFI_EXIT_BOOT_SERVICES_SUCCEEDED \\r
66 "Exit Boot Services Returned with Success"\r
67\r
2096185d 68\r
69#define EV_POSTCODE_INFO_POST_CODE "POST CODE"\r
70#define POST_CODE_STR_LEN (sizeof(EV_POSTCODE_INFO_POST_CODE) - 1)\r
71\r
72#define EV_POSTCODE_INFO_SMM_CODE "SMM CODE"\r
73#define SMM_CODE_STR_LEN (sizeof(EV_POSTCODE_INFO_SMM_CODE) - 1)\r
74\r
75#define EV_POSTCODE_INFO_ACPI_DATA "ACPI DATA"\r
76#define ACPI_DATA_LEN (sizeof(EV_POSTCODE_INFO_ACPI_DATA) - 1)\r
77\r
78#define EV_POSTCODE_INFO_BIS_CODE "BIS CODE"\r
79#define BIS_CODE_LEN (sizeof(EV_POSTCODE_INFO_BIS_CODE) - 1)\r
80\r
81#define EV_POSTCODE_INFO_UEFI_PI "UEFI PI"\r
82#define UEFI_PI_LEN (sizeof(EV_POSTCODE_INFO_UEFI_PI) - 1)\r
83\r
84#define EV_POSTCODE_INFO_OPROM "Embedded Option ROM"\r
85#define OPROM_LEN (sizeof(EV_POSTCODE_INFO_OPROM) - 1)\r
86\r
59b226d6
JY
87#define FIRMWARE_DEBUGGER_EVENT_STRING "UEFI Debug Mode"\r
88#define FIRMWARE_DEBUGGER_EVENT_STRING_LEN (sizeof(FIRMWARE_DEBUGGER_EVENT_STRING) - 1)\r
89\r
267669ba
LG
90//\r
91// Set structure alignment to 1-byte\r
92//\r
a04ad3f0 93#pragma pack (1)\r
267669ba
LG
94\r
95typedef UINT32 TCG_EVENTTYPE;\r
992f22b9
LG
96typedef TPM_PCRINDEX TCG_PCRINDEX;\r
97typedef TPM_DIGEST TCG_DIGEST;\r
fb5148a0 98///\r
3ed785e9 99/// Event Log Entry Structure Definition\r
fb5148a0 100///\r
267669ba 101typedef struct tdTCG_PCR_EVENT {\r
3ed785e9 102 TCG_PCRINDEX PCRIndex; ///< PCRIndex event extended to\r
103 TCG_EVENTTYPE EventType; ///< TCG EFI event type\r
104 TCG_DIGEST Digest; ///< Value extended into PCRIndex\r
105 UINT32 EventSize; ///< Size of the event data\r
106 UINT8 Event[1]; ///< The event data\r
267669ba
LG
107} TCG_PCR_EVENT;\r
108\r
3ed785e9 109#define TSS_EVENT_DATA_MAX_SIZE 256\r
110\r
fb5148a0 111///\r
112/// TCG_PCR_EVENT_HDR\r
113///\r
267669ba
LG
114typedef struct tdTCG_PCR_EVENT_HDR {\r
115 TCG_PCRINDEX PCRIndex;\r
116 TCG_EVENTTYPE EventType;\r
117 TCG_DIGEST Digest;\r
118 UINT32 EventSize;\r
119} TCG_PCR_EVENT_HDR;\r
120\r
fb5148a0 121///\r
122/// EFI_PLATFORM_FIRMWARE_BLOB\r
123///\r
124/// BlobLength should be of type UINTN but we use UINT64 here\r
125/// because PEI is 32-bit while DXE is 64-bit on x64 platforms\r
126///\r
267669ba
LG
127typedef struct tdEFI_PLATFORM_FIRMWARE_BLOB {\r
128 EFI_PHYSICAL_ADDRESS BlobBase;\r
129 UINT64 BlobLength;\r
130} EFI_PLATFORM_FIRMWARE_BLOB;\r
131\r
fb5148a0 132///\r
133/// EFI_IMAGE_LOAD_EVENT\r
134///\r
135/// This structure is used in EV_EFI_BOOT_SERVICES_APPLICATION,\r
136/// EV_EFI_BOOT_SERVICES_DRIVER and EV_EFI_RUNTIME_SERVICES_DRIVER\r
137///\r
267669ba
LG
138typedef struct tdEFI_IMAGE_LOAD_EVENT {\r
139 EFI_PHYSICAL_ADDRESS ImageLocationInMemory;\r
140 UINTN ImageLengthInMemory;\r
141 UINTN ImageLinkTimeAddress;\r
142 UINTN LengthOfDevicePath;\r
143 EFI_DEVICE_PATH_PROTOCOL DevicePath[1];\r
144} EFI_IMAGE_LOAD_EVENT;\r
145\r
fb5148a0 146///\r
147/// EFI_HANDOFF_TABLE_POINTERS\r
148///\r
149/// This structure is used in EV_EFI_HANDOFF_TABLES event to facilitate\r
150/// the measurement of given configuration tables.\r
151///\r
267669ba 152typedef struct tdEFI_HANDOFF_TABLE_POINTERS {\r
3ed785e9 153 UINTN NumberOfTables;\r
267669ba
LG
154 EFI_CONFIGURATION_TABLE TableEntry[1];\r
155} EFI_HANDOFF_TABLE_POINTERS;\r
156\r
fb5148a0 157///\r
158/// EFI_VARIABLE_DATA\r
159///\r
160/// This structure serves as the header for measuring variables. The name of the\r
161/// variable (in Unicode format) should immediately follow, then the variable\r
162/// data.\r
49945882 163/// This is defined in TCG EFI Platform Spec for TPM1.1 or 1.2 V1.22\r
fb5148a0 164///\r
267669ba
LG
165typedef struct tdEFI_VARIABLE_DATA {\r
166 EFI_GUID VariableName;\r
167 UINTN UnicodeNameLength;\r
168 UINTN VariableDataLength;\r
169 CHAR16 UnicodeName[1];\r
3ed785e9 170 INT8 VariableData[1]; ///< Driver or platform-specific data\r
267669ba
LG
171} EFI_VARIABLE_DATA;\r
172\r
49945882
ZC
173///\r
174/// UEFI_VARIABLE_DATA\r
175///\r
176/// This structure serves as the header for measuring variables. The name of the\r
177/// variable (in Unicode format) should immediately follow, then the variable\r
178/// data.\r
179/// This is defined in TCG PC Client Firmware Profile Spec 00.21\r
180///\r
181typedef struct tdUEFI_VARIABLE_DATA {\r
182 EFI_GUID VariableName;\r
183 UINT64 UnicodeNameLength;\r
184 UINT64 VariableDataLength;\r
185 CHAR16 UnicodeName[1];\r
186 INT8 VariableData[1]; ///< Driver or platform-specific data\r
187} UEFI_VARIABLE_DATA;\r
188\r
59b226d6
JY
189//\r
190// For TrEE1.0 compatibility\r
191//\r
192typedef struct {\r
193 EFI_GUID VariableName;\r
194 UINT64 UnicodeNameLength; // The TCG Definition used UINTN\r
195 UINT64 VariableDataLength; // The TCG Definition used UINTN\r
196 CHAR16 UnicodeName[1];\r
197 INT8 VariableData[1];\r
198} EFI_VARIABLE_DATA_TREE;\r
199\r
267669ba
LG
200typedef struct tdEFI_GPT_DATA {\r
201 EFI_PARTITION_TABLE_HEADER EfiPartitionHeader;\r
9095d37b 202 UINTN NumberOfPartitions;\r
267669ba
LG
203 EFI_PARTITION_ENTRY Partitions[1];\r
204} EFI_GPT_DATA;\r
205\r
59b226d6
JY
206//\r
207// Crypto Agile Log Entry Format\r
208//\r
209typedef struct tdTCG_PCR_EVENT2 {\r
210 TCG_PCRINDEX PCRIndex;\r
211 TCG_EVENTTYPE EventType;\r
212 TPML_DIGEST_VALUES Digest;\r
213 UINT32 EventSize;\r
214 UINT8 Event[1];\r
215} TCG_PCR_EVENT2;\r
216\r
c5647c6c
ZC
217//\r
218// TCG PCR Event2 Header\r
219// Follow TCG EFI Protocol Spec 5.2 Crypto Agile Log Entry Format\r
220//\r
221typedef struct tdTCG_PCR_EVENT2_HDR{\r
222 TCG_PCRINDEX PCRIndex;\r
223 TCG_EVENTTYPE EventType;\r
224 TPML_DIGEST_VALUES Digests;\r
225 UINT32 EventSize;\r
226} TCG_PCR_EVENT2_HDR;\r
227\r
59b226d6
JY
228//\r
229// Log Header Entry Data\r
230//\r
231typedef struct {\r
232 //\r
233 // TCG defined hashing algorithm ID.\r
234 //\r
235 UINT16 algorithmId;\r
236 //\r
237 // The size of the digest for the respective hashing algorithm.\r
238 //\r
239 UINT16 digestSize;\r
240} TCG_EfiSpecIdEventAlgorithmSize;\r
241\r
242#define TCG_EfiSpecIDEventStruct_SIGNATURE_02 "Spec ID Event02"\r
243#define TCG_EfiSpecIDEventStruct_SIGNATURE_03 "Spec ID Event03"\r
244\r
245#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM12 1\r
246#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM12 2\r
247#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM12 2\r
248\r
249#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM2 2\r
250#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM2 0\r
251#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2 0\r
252\r
253typedef struct {\r
254 UINT8 signature[16];\r
255 //\r
256 // The value for the Platform Class.\r
257 // The enumeration is defined in the TCG ACPI Specification Client Common Header.\r
258 //\r
259 UINT32 platformClass;\r
260 //\r
261 // The TCG EFI Platform Specification minor version number this BIOS supports.\r
262 // Any BIOS supporting version (1.22) MUST set this value to 02h.\r
263 // Any BIOS supporting version (2.0) SHALL set this value to 0x00.\r
264 //\r
265 UINT8 specVersionMinor;\r
266 //\r
267 // The TCG EFI Platform Specification major version number this BIOS supports.\r
268 // Any BIOS supporting version (1.22) MUST set this value to 01h.\r
269 // Any BIOS supporting version (2.0) SHALL set this value to 0x02.\r
270 //\r
271 UINT8 specVersionMajor;\r
272 //\r
273 // The TCG EFI Platform Specification errata for this specification this BIOS supports.\r
274 // Any BIOS supporting version and errata (1.22) MUST set this value to 02h.\r
275 // Any BIOS supporting version and errata (2.0) SHALL set this value to 0x00.\r
276 //\r
277 UINT8 specErrata;\r
278 //\r
279 // Specifies the size of the UINTN fields used in various data structures used in this specification.\r
280 // 0x01 indicates UINT32 and 0x02 indicates UINT64.\r
281 //\r
282 UINT8 uintnSize;\r
283 //\r
284 // This field is added in "Spec ID Event03".\r
285 // The number of hashing algorithms used in this event log (except the first event).\r
286 // All events in this event log use all hashing algorithms defined here.\r
287 //\r
288//UINT32 numberOfAlgorithms;\r
289 //\r
290 // This field is added in "Spec ID Event03".\r
291 // An array of size numberOfAlgorithms of value pairs.\r
292 //\r
293//TCG_EfiSpecIdEventAlgorithmSize digestSize[numberOfAlgorithms];\r
294 //\r
295 // Size in bytes of the VendorInfo field.\r
296 // Maximum value SHALL be FFh bytes.\r
297 //\r
298//UINT8 vendorInfoSize;\r
299 //\r
300 // Provided for use by the BIOS implementer.\r
301 // The value might be used, for example, to provide more detailed information about the specific BIOS such as BIOS revision numbers, etc.\r
302 // The values within this field are not standardized and are implementer-specific.\r
303 // Platform-specific or -unique information SHALL NOT be provided in this field.\r
304 //\r
305//UINT8 vendorInfo[vendorInfoSize];\r
306} TCG_EfiSpecIDEventStruct;\r
307\r
6671cd74
ZC
308\r
309\r
310#define TCG_EfiStartupLocalityEvent_SIGNATURE "StartupLocality"\r
311\r
312\r
313//\r
314// PC Client PTP spec Table 8 Relationship between Locality and Locality Attribute\r
315//\r
316#define LOCALITY_0_INDICATOR 0x01\r
317#define LOCALITY_1_INDICATOR 0x02\r
318#define LOCALITY_2_INDICATOR 0x03\r
319#define LOCALITY_3_INDICATOR 0x04\r
320#define LOCALITY_4_INDICATOR 0x05\r
321\r
322\r
323//\r
324// Startup Locality Event\r
325//\r
326typedef struct tdTCG_EfiStartupLocalityEvent{\r
327 UINT8 Signature[16];\r
328 //\r
329 // The Locality Indicator which sent the TPM2_Startup command\r
330 //\r
331 UINT8 StartupLocality;\r
332} TCG_EfiStartupLocalityEvent;\r
333\r
334\r
267669ba
LG
335//\r
336// Restore original structure alignment\r
337//\r
a04ad3f0 338#pragma pack ()\r
267669ba
LG
339\r
340#endif\r
341\r
342\r