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