[mirror_edk2.git] / MdePkg / Include / IndustryStandard / UefiTcgPlatform.h

/** @file\r
  TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final and\r
  TCG PC Client Platform Firmware Profile Specification, Revision 1.05\r
\r
  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __UEFI_TCG_PLATFORM_H__\r
#define __UEFI_TCG_PLATFORM_H__\r
\r
#include <IndustryStandard/Tpm12.h>\r
#include <IndustryStandard/Tpm20.h>\r
#include <Uefi.h>\r
\r
//\r
// Standard event types\r
//\r
#define EV_PREBOOT_CERT             ((TCG_EVENTTYPE) 0x00000000)\r
#define EV_POST_CODE                ((TCG_EVENTTYPE) 0x00000001)\r
#define EV_NO_ACTION                ((TCG_EVENTTYPE) 0x00000003)\r
#define EV_SEPARATOR                ((TCG_EVENTTYPE) 0x00000004)\r
#define EV_ACTION                   ((TCG_EVENTTYPE) 0x00000005)\r
#define EV_EVENT_TAG                ((TCG_EVENTTYPE) 0x00000006)\r
#define EV_S_CRTM_CONTENTS          ((TCG_EVENTTYPE) 0x00000007)\r
#define EV_S_CRTM_VERSION           ((TCG_EVENTTYPE) 0x00000008)\r
#define EV_CPU_MICROCODE            ((TCG_EVENTTYPE) 0x00000009)\r
#define EV_PLATFORM_CONFIG_FLAGS    ((TCG_EVENTTYPE) 0x0000000A)\r
#define EV_TABLE_OF_DEVICES         ((TCG_EVENTTYPE) 0x0000000B)\r
#define EV_COMPACT_HASH             ((TCG_EVENTTYPE) 0x0000000C)\r
#define EV_NONHOST_CODE             ((TCG_EVENTTYPE) 0x0000000F)\r
#define EV_NONHOST_CONFIG           ((TCG_EVENTTYPE) 0x00000010)\r
#define EV_NONHOST_INFO             ((TCG_EVENTTYPE) 0x00000011)\r
#define EV_OMIT_BOOT_DEVICE_EVENTS  ((TCG_EVENTTYPE) 0x00000012)\r
\r
//\r
// EFI specific event types\r
//\r
#define EV_EFI_EVENT_BASE                 ((TCG_EVENTTYPE) 0x80000000)\r
#define EV_EFI_VARIABLE_DRIVER_CONFIG     (EV_EFI_EVENT_BASE + 1)\r
#define EV_EFI_VARIABLE_BOOT              (EV_EFI_EVENT_BASE + 2)\r
#define EV_EFI_BOOT_SERVICES_APPLICATION  (EV_EFI_EVENT_BASE + 3)\r
#define EV_EFI_BOOT_SERVICES_DRIVER       (EV_EFI_EVENT_BASE + 4)\r
#define EV_EFI_RUNTIME_SERVICES_DRIVER    (EV_EFI_EVENT_BASE + 5)\r
#define EV_EFI_GPT_EVENT                  (EV_EFI_EVENT_BASE + 6)\r
#define EV_EFI_ACTION                     (EV_EFI_EVENT_BASE + 7)\r
#define EV_EFI_PLATFORM_FIRMWARE_BLOB     (EV_EFI_EVENT_BASE + 8)\r
#define EV_EFI_HANDOFF_TABLES             (EV_EFI_EVENT_BASE + 9)\r
#define EV_EFI_PLATFORM_FIRMWARE_BLOB2    (EV_EFI_EVENT_BASE + 0xA)\r
#define EV_EFI_HANDOFF_TABLES2            (EV_EFI_EVENT_BASE + 0xB)\r
#define EV_EFI_HCRTM_EVENT                (EV_EFI_EVENT_BASE + 0x10)\r
#define EV_EFI_VARIABLE_AUTHORITY         (EV_EFI_EVENT_BASE + 0xE0)\r
#define EV_EFI_SPDM_FIRMWARE_BLOB         (EV_EFI_EVENT_BASE + 0xE1)\r
#define EV_EFI_SPDM_FIRMWARE_CONFIG       (EV_EFI_EVENT_BASE + 0xE2)\r
\r
#define EFI_CALLING_EFI_APPLICATION         \\r
  "Calling EFI Application from Boot Option"\r
#define EFI_RETURNING_FROM_EFI_APPLICATION  \\r
  "Returning from EFI Application from Boot Option"\r
#define EFI_EXIT_BOOT_SERVICES_INVOCATION   \\r
  "Exit Boot Services Invocation"\r
#define EFI_EXIT_BOOT_SERVICES_FAILED       \\r
  "Exit Boot Services Returned with Failure"\r
#define EFI_EXIT_BOOT_SERVICES_SUCCEEDED    \\r
  "Exit Boot Services Returned with Success"\r
\r
#define EV_POSTCODE_INFO_POST_CODE  "POST CODE"\r
#define POST_CODE_STR_LEN           (sizeof(EV_POSTCODE_INFO_POST_CODE) - 1)\r
\r
#define EV_POSTCODE_INFO_SMM_CODE  "SMM CODE"\r
#define SMM_CODE_STR_LEN           (sizeof(EV_POSTCODE_INFO_SMM_CODE) - 1)\r
\r
#define EV_POSTCODE_INFO_ACPI_DATA  "ACPI DATA"\r
#define ACPI_DATA_LEN               (sizeof(EV_POSTCODE_INFO_ACPI_DATA) - 1)\r
\r
#define EV_POSTCODE_INFO_BIS_CODE  "BIS CODE"\r
#define BIS_CODE_LEN               (sizeof(EV_POSTCODE_INFO_BIS_CODE) - 1)\r
\r
#define EV_POSTCODE_INFO_UEFI_PI  "UEFI PI"\r
#define UEFI_PI_LEN               (sizeof(EV_POSTCODE_INFO_UEFI_PI) - 1)\r
\r
#define EV_POSTCODE_INFO_OPROM  "Embedded Option ROM"\r
#define OPROM_LEN               (sizeof(EV_POSTCODE_INFO_OPROM) - 1)\r
\r
#define EV_POSTCODE_INFO_EMBEDDED_UEFI_DRIVER  "Embedded UEFI Driver"\r
#define EMBEDDED_UEFI_DRIVER_LEN               (sizeof(EV_POSTCODE_INFO_EMBEDDED_UEFI_DRIVER) - 1)\r
\r
#define FIRMWARE_DEBUGGER_EVENT_STRING      "UEFI Debug Mode"\r
#define FIRMWARE_DEBUGGER_EVENT_STRING_LEN  (sizeof(FIRMWARE_DEBUGGER_EVENT_STRING) - 1)\r
\r
//\r
// Set structure alignment to 1-byte\r
//\r
#pragma pack (1)\r
\r
typedef UINT32        TCG_EVENTTYPE;\r
typedef TPM_PCRINDEX  TCG_PCRINDEX;\r
typedef TPM_DIGEST    TCG_DIGEST;\r
///\r
/// Event Log Entry Structure Definition\r
///\r
typedef struct tdTCG_PCR_EVENT {\r
  TCG_PCRINDEX     PCRIndex;                   ///< PCRIndex event extended to\r
  TCG_EVENTTYPE    EventType;                  ///< TCG EFI event type\r
  TCG_DIGEST       Digest;                     ///< Value extended into PCRIndex\r
  UINT32           EventSize;                  ///< Size of the event data\r
  UINT8            Event[1];                   ///< The event data\r
} TCG_PCR_EVENT;\r
\r
#define TSS_EVENT_DATA_MAX_SIZE  256\r
\r
///\r
/// TCG_PCR_EVENT_HDR\r
///\r
typedef struct tdTCG_PCR_EVENT_HDR {\r
  TCG_PCRINDEX     PCRIndex;\r
  TCG_EVENTTYPE    EventType;\r
  TCG_DIGEST       Digest;\r
  UINT32           EventSize;\r
} TCG_PCR_EVENT_HDR;\r
\r
///\r
/// EFI_PLATFORM_FIRMWARE_BLOB\r
///\r
/// BlobLength should be of type UINTN but we use UINT64 here\r
/// because PEI is 32-bit while DXE is 64-bit on x64 platforms\r
///\r
typedef struct tdEFI_PLATFORM_FIRMWARE_BLOB {\r
  EFI_PHYSICAL_ADDRESS    BlobBase;\r
  UINT64                  BlobLength;\r
} EFI_PLATFORM_FIRMWARE_BLOB;\r
\r
///\r
/// UEFI_PLATFORM_FIRMWARE_BLOB\r
///\r
/// This structure is used in EV_EFI_PLATFORM_FIRMWARE_BLOB\r
/// event to facilitate the measurement of firmware volume.\r
///\r
typedef struct tdUEFI_PLATFORM_FIRMWARE_BLOB {\r
  EFI_PHYSICAL_ADDRESS    BlobBase;\r
  UINT64                  BlobLength;\r
} UEFI_PLATFORM_FIRMWARE_BLOB;\r
\r
///\r
/// UEFI_PLATFORM_FIRMWARE_BLOB2\r
///\r
/// This structure is used in EV_EFI_PLATFORM_FIRMWARE_BLOB2\r
/// event to facilitate the measurement of firmware volume.\r
///\r
typedef struct tdUEFI_PLATFORM_FIRMWARE_BLOB2 {\r
  UINT8    BlobDescriptionSize;\r
  // UINT8                             BlobDescription[BlobDescriptionSize];\r
  // EFI_PHYSICAL_ADDRESS              BlobBase;\r
  // UINT64                            BlobLength;\r
} UEFI_PLATFORM_FIRMWARE_BLOB2;\r
\r
///\r
/// EFI_IMAGE_LOAD_EVENT\r
///\r
/// This structure is used in EV_EFI_BOOT_SERVICES_APPLICATION,\r
/// EV_EFI_BOOT_SERVICES_DRIVER and EV_EFI_RUNTIME_SERVICES_DRIVER\r
///\r
typedef struct tdEFI_IMAGE_LOAD_EVENT {\r
  EFI_PHYSICAL_ADDRESS        ImageLocationInMemory;\r
  UINTN                       ImageLengthInMemory;\r
  UINTN                       ImageLinkTimeAddress;\r
  UINTN                       LengthOfDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL    DevicePath[1];\r
} EFI_IMAGE_LOAD_EVENT;\r
\r
///\r
/// UEFI_IMAGE_LOAD_EVENT\r
///\r
/// This structure is used in EV_EFI_BOOT_SERVICES_APPLICATION,\r
/// EV_EFI_BOOT_SERVICES_DRIVER and EV_EFI_RUNTIME_SERVICES_DRIVER\r
///\r
typedef struct tdUEFI_IMAGE_LOAD_EVENT {\r
  EFI_PHYSICAL_ADDRESS        ImageLocationInMemory;\r
  UINT64                      ImageLengthInMemory;\r
  UINT64                      ImageLinkTimeAddress;\r
  UINT64                      LengthOfDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL    DevicePath[1];\r
} UEFI_IMAGE_LOAD_EVENT;\r
\r
///\r
/// EFI_HANDOFF_TABLE_POINTERS\r
///\r
/// This structure is used in EV_EFI_HANDOFF_TABLES event to facilitate\r
/// the measurement of given configuration tables.\r
///\r
typedef struct tdEFI_HANDOFF_TABLE_POINTERS {\r
  UINTN                      NumberOfTables;\r
  EFI_CONFIGURATION_TABLE    TableEntry[1];\r
} EFI_HANDOFF_TABLE_POINTERS;\r
\r
///\r
/// UEFI_HANDOFF_TABLE_POINTERS\r
///\r
/// This structure is used in EV_EFI_HANDOFF_TABLES event to facilitate\r
/// the measurement of given configuration tables.\r
///\r
typedef struct tdUEFI_HANDOFF_TABLE_POINTERS {\r
  UINT64                     NumberOfTables;\r
  EFI_CONFIGURATION_TABLE    TableEntry[1];\r
} UEFI_HANDOFF_TABLE_POINTERS;\r
\r
///\r
/// UEFI_HANDOFF_TABLE_POINTERS2\r
///\r
/// This structure is used in EV_EFI_HANDOFF_TABLES2 event to facilitate\r
/// the measurement of given configuration tables.\r
///\r
typedef struct tdUEFI_HANDOFF_TABLE_POINTERS2 {\r
  UINT8    TableDescriptionSize;\r
  // UINT8                             TableDescription[TableDescriptionSize];\r
  // UINT64                            NumberOfTables;\r
  // EFI_CONFIGURATION_TABLE           TableEntry[1];\r
} UEFI_HANDOFF_TABLE_POINTERS2;\r
\r
///\r
/// EFI_VARIABLE_DATA\r
///\r
/// This structure serves as the header for measuring variables. The name of the\r
/// variable (in Unicode format) should immediately follow, then the variable\r
/// data.\r
/// This is defined in TCG EFI Platform Spec for TPM1.1 or 1.2 V1.22\r
///\r
typedef struct tdEFI_VARIABLE_DATA {\r
  EFI_GUID    VariableName;\r
  UINTN       UnicodeNameLength;\r
  UINTN       VariableDataLength;\r
  CHAR16      UnicodeName[1];\r
  INT8        VariableData[1];                        ///< Driver or platform-specific data\r
} EFI_VARIABLE_DATA;\r
\r
///\r
/// UEFI_VARIABLE_DATA\r
///\r
/// This structure serves as the header for measuring variables. The name of the\r
/// variable (in Unicode format) should immediately follow, then the variable\r
/// data.\r
/// This is defined in TCG PC Client Firmware Profile Spec 00.21\r
///\r
typedef struct tdUEFI_VARIABLE_DATA {\r
  EFI_GUID    VariableName;\r
  UINT64      UnicodeNameLength;\r
  UINT64      VariableDataLength;\r
  CHAR16      UnicodeName[1];\r
  INT8        VariableData[1];                        ///< Driver or platform-specific data\r
} UEFI_VARIABLE_DATA;\r
\r
//\r
// For TrEE1.0 compatibility\r
//\r
typedef struct {\r
  EFI_GUID    VariableName;\r
  UINT64      UnicodeNameLength;                         // The TCG Definition used UINTN\r
  UINT64      VariableDataLength;                        // The TCG Definition used UINTN\r
  CHAR16      UnicodeName[1];\r
  INT8        VariableData[1];\r
} EFI_VARIABLE_DATA_TREE;\r
\r
typedef struct tdEFI_GPT_DATA {\r
  EFI_PARTITION_TABLE_HEADER    EfiPartitionHeader;\r
  UINTN                         NumberOfPartitions;\r
  EFI_PARTITION_ENTRY           Partitions[1];\r
} EFI_GPT_DATA;\r
\r
typedef struct tdUEFI_GPT_DATA {\r
  EFI_PARTITION_TABLE_HEADER    EfiPartitionHeader;\r
  UINT64                        NumberOfPartitions;\r
  EFI_PARTITION_ENTRY           Partitions[1];\r
} UEFI_GPT_DATA;\r
\r
#define TCG_DEVICE_SECURITY_EVENT_DATA_SIGNATURE  "SPDM Device Sec"\r
#define TCG_DEVICE_SECURITY_EVENT_DATA_VERSION    1\r
\r
#define TCG_DEVICE_SECURITY_EVENT_DATA_DEVICE_TYPE_NULL  0\r
#define TCG_DEVICE_SECURITY_EVENT_DATA_DEVICE_TYPE_PCI   1\r
#define TCG_DEVICE_SECURITY_EVENT_DATA_DEVICE_TYPE_USB   2\r
\r
///\r
/// TCG_DEVICE_SECURITY_EVENT_DATA_HEADER\r
/// This is the header of TCG_DEVICE_SECURITY_EVENT_DATA, which is\r
/// used in EV_EFI_SPDM_FIRMWARE_BLOB and EV_EFI_SPDM_FIRMWARE_CONFIG.\r
///\r
typedef struct {\r
  UINT8     Signature[16];\r
  UINT16    Version;\r
  UINT16    Length;\r
  UINT32    SpdmHashAlgo;\r
  UINT32    DeviceType;\r
  // SPDM_MEASUREMENT_BLOCK         SpdmMeasurementBlock;\r
} TCG_DEVICE_SECURITY_EVENT_DATA_HEADER;\r
\r
#define TCG_DEVICE_SECURITY_EVENT_DATA_PCI_CONTEXT_VERSION  0\r
\r
///\r
/// TCG_DEVICE_SECURITY_EVENT_DATA_PCI_CONTEXT\r
/// This is the PCI context data of TCG_DEVICE_SECURITY_EVENT_DATA, which is\r
/// used in EV_EFI_SPDM_FIRMWARE_BLOB and EV_EFI_SPDM_FIRMWARE_CONFIG.\r
///\r
typedef struct {\r
  UINT16    Version;\r
  UINT16    Length;\r
  UINT16    VendorId;\r
  UINT16    DeviceId;\r
  UINT8     RevisionID;\r
  UINT8     ClassCode[3];\r
  UINT16    SubsystemVendorID;\r
  UINT16    SubsystemID;\r
} TCG_DEVICE_SECURITY_EVENT_DATA_PCI_CONTEXT;\r
\r
#define TCG_DEVICE_SECURITY_EVENT_DATA_USB_CONTEXT_VERSION  0\r
\r
///\r
/// TCG_DEVICE_SECURITY_EVENT_DATA_USB_CONTEXT\r
/// This is the USB context data of TCG_DEVICE_SECURITY_EVENT_DATA, which is\r
/// used in EV_EFI_SPDM_FIRMWARE_BLOB and EV_EFI_SPDM_FIRMWARE_CONFIG.\r
///\r
typedef struct {\r
  UINT16    Version;\r
  UINT16    Length;\r
  // UINT8   DeviceDescriptor[DescLen];\r
  // UINT8   BodDescriptor[DescLen];\r
  // UINT8   ConfigurationDescriptor[DescLen][NumOfConfiguration];\r
} TCG_DEVICE_SECURITY_EVENT_DATA_USB_CONTEXT;\r
\r
//\r
// Crypto Agile Log Entry Format\r
//\r
typedef struct tdTCG_PCR_EVENT2 {\r
  TCG_PCRINDEX          PCRIndex;\r
  TCG_EVENTTYPE         EventType;\r
  TPML_DIGEST_VALUES    Digest;\r
  UINT32                EventSize;\r
  UINT8                 Event[1];\r
} TCG_PCR_EVENT2;\r
\r
//\r
// TCG PCR Event2 Header\r
// Follow TCG EFI Protocol Spec 5.2 Crypto Agile Log Entry Format\r
//\r
typedef struct tdTCG_PCR_EVENT2_HDR {\r
  TCG_PCRINDEX          PCRIndex;\r
  TCG_EVENTTYPE         EventType;\r
  TPML_DIGEST_VALUES    Digests;\r
  UINT32                EventSize;\r
} TCG_PCR_EVENT2_HDR;\r
\r
//\r
// Log Header Entry Data\r
//\r
typedef struct {\r
  //\r
  // TCG defined hashing algorithm ID.\r
  //\r
  UINT16    algorithmId;\r
  //\r
  // The size of the digest for the respective hashing algorithm.\r
  //\r
  UINT16    digestSize;\r
} TCG_EfiSpecIdEventAlgorithmSize;\r
\r
#define TCG_EfiSpecIDEventStruct_SIGNATURE_02  "Spec ID Event02"\r
#define TCG_EfiSpecIDEventStruct_SIGNATURE_03  "Spec ID Event03"\r
\r
#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM12  1\r
#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM12  2\r
#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM12         2\r
\r
#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM2   2\r
#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM2   0\r
#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2          0\r
#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2_REV_105  105\r
\r
typedef struct {\r
  UINT8     signature[16];\r
  //\r
  // The value for the Platform Class.\r
  // The enumeration is defined in the TCG ACPI Specification Client Common Header.\r
  //\r
  UINT32    platformClass;\r
  //\r
  // The TCG EFI Platform Specification minor version number this BIOS supports.\r
  // Any BIOS supporting version (1.22) MUST set this value to 02h.\r
  // Any BIOS supporting version (2.0) SHALL set this value to 0x00.\r
  //\r
  UINT8     specVersionMinor;\r
  //\r
  // The TCG EFI Platform Specification major version number this BIOS supports.\r
  // Any BIOS supporting version (1.22) MUST set this value to 01h.\r
  // Any BIOS supporting version (2.0) SHALL set this value to 0x02.\r
  //\r
  UINT8     specVersionMajor;\r
  //\r
  // The TCG EFI Platform Specification errata for this specification this BIOS supports.\r
  // Any BIOS supporting version and errata (1.22) MUST set this value to 02h.\r
  // Any BIOS supporting version and errata (2.0) SHALL set this value to 0x00.\r
  //\r
  UINT8     specErrata;\r
  //\r
  // Specifies the size of the UINTN fields used in various data structures used in this specification.\r
  // 0x01 indicates UINT32 and 0x02 indicates UINT64.\r
  //\r
  UINT8     uintnSize;\r
  //\r
  // This field is added in "Spec ID Event03".\r
  // The number of hashing algorithms used in this event log (except the first event).\r
  // All events in this event log use all hashing algorithms defined here.\r
  //\r
  // UINT32              numberOfAlgorithms;\r
  //\r
  // This field is added in "Spec ID Event03".\r
  // An array of size numberOfAlgorithms of value pairs.\r
  //\r
  // TCG_EfiSpecIdEventAlgorithmSize digestSize[numberOfAlgorithms];\r
  //\r
  // Size in bytes of the VendorInfo field.\r
  // Maximum value SHALL be FFh bytes.\r
  //\r
  // UINT8               vendorInfoSize;\r
  //\r
  // Provided for use by the BIOS implementer.\r
  // The value might be used, for example, to provide more detailed information about the specific BIOS such as BIOS revision numbers, etc.\r
  // The values within this field are not standardized and are implementer-specific.\r
  // Platform-specific or -unique information SHALL NOT be provided in this field.\r
  //\r
  // UINT8               vendorInfo[vendorInfoSize];\r
} TCG_EfiSpecIDEventStruct;\r
\r
typedef struct tdTCG_PCClientTaggedEvent {\r
  UINT32    taggedEventID;\r
  UINT32    taggedEventDataSize;\r
  // UINT8               taggedEventData[taggedEventDataSize];\r
} TCG_PCClientTaggedEvent;\r
\r
#define TCG_Sp800_155_PlatformId_Event_SIGNATURE   "SP800-155 Event"\r
#define TCG_Sp800_155_PlatformId_Event2_SIGNATURE  "SP800-155 Event2"\r
\r
typedef struct tdTCG_Sp800_155_PlatformId_Event2 {\r
  UINT8       Signature[16];\r
  //\r
  // Where Vendor ID is an integer defined\r
  // at http://www.iana.org/assignments/enterprisenumbers\r
  //\r
  UINT32      VendorId;\r
  //\r
  // 16-byte identifier of a given platform's static configuration of code\r
  //\r
  EFI_GUID    ReferenceManifestGuid;\r
  //\r
  // Below structure is newly added in TCG_Sp800_155_PlatformId_Event2.\r
  //\r
  // UINT8               PlatformManufacturerStrSize;\r
  // UINT8               PlatformManufacturerStr[PlatformManufacturerStrSize];\r
  // UINT8               PlatformModelSize;\r
  // UINT8               PlatformModel[PlatformModelSize];\r
  // UINT8               PlatformVersionSize;\r
  // UINT8               PlatformVersion[PlatformVersionSize];\r
  // UINT8               PlatformModelSize;\r
  // UINT8               PlatformModel[PlatformModelSize];\r
  // UINT8               FirmwareManufacturerStrSize;\r
  // UINT8               FirmwareManufacturerStr[FirmwareManufacturerStrSize];\r
  // UINT32              FirmwareManufacturerId;\r
  // UINT8               FirmwareVersion;\r
  // UINT8               FirmwareVersion[FirmwareVersionSize]];\r
} TCG_Sp800_155_PlatformId_Event2;\r
\r
#define TCG_EfiStartupLocalityEvent_SIGNATURE  "StartupLocality"\r
\r
//\r
// The Locality Indicator which sent the TPM2_Startup command\r
//\r
#define LOCALITY_0_INDICATOR  0x00\r
#define LOCALITY_3_INDICATOR  0x03\r
\r
//\r
// Startup Locality Event\r
//\r
typedef struct tdTCG_EfiStartupLocalityEvent {\r
  UINT8    Signature[16];\r
  //\r
  // The Locality Indicator which sent the TPM2_Startup command\r
  //\r
  UINT8    StartupLocality;\r
} TCG_EfiStartupLocalityEvent;\r
\r
//\r
// Restore original structure alignment\r
//\r
#pragma pack ()\r
\r
#endif\r
Commit	Line	Data
c311f86b	1	/** @file\r
ec8c74e8 JY	2	TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final and\r
ec8c74e8 JY	3	TCG PC Client Platform Firmware Profile Specification, Revision 1.05\r
267669ba	4	\r
ec8c74e8	5	Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
9344f092	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
267669ba LG	7	\r
	8	**/\r
	9	\r
	10	#ifndef __UEFI_TCG_PLATFORM_H__\r
22a25d24	11	#define __UEFI_TCG_PLATFORM_H__\r
267669ba LG	12	\r
267669ba LG	13	#include <IndustryStandard/Tpm12.h>\r
59b226d6	14	#include <IndustryStandard/Tpm20.h>\r
a979fca9	15	#include <Uefi.h>\r
1fd83dd2	16	\r
267669ba LG	17	//\r
	18	// Standard event types\r
	19	//\r
4187f79c	20	#define EV_PREBOOT_CERT ((TCG_EVENTTYPE) 0x00000000)\r
267669ba	21	#define EV_POST_CODE ((TCG_EVENTTYPE) 0x00000001)\r
59b226d6	22	#define EV_NO_ACTION ((TCG_EVENTTYPE) 0x00000003)\r
267669ba	23	#define EV_SEPARATOR ((TCG_EVENTTYPE) 0x00000004)\r
4187f79c	24	#define EV_ACTION ((TCG_EVENTTYPE) 0x00000005)\r
ec8c74e8	25	#define EV_EVENT_TAG ((TCG_EVENTTYPE) 0x00000006)\r
267669ba LG	26	#define EV_S_CRTM_CONTENTS ((TCG_EVENTTYPE) 0x00000007)\r
267669ba LG	27	#define EV_S_CRTM_VERSION ((TCG_EVENTTYPE) 0x00000008)\r
04a89420	28	#define EV_CPU_MICROCODE ((TCG_EVENTTYPE) 0x00000009)\r
4187f79c	29	#define EV_PLATFORM_CONFIG_FLAGS ((TCG_EVENTTYPE) 0x0000000A)\r
f5a859d6	30	#define EV_TABLE_OF_DEVICES ((TCG_EVENTTYPE) 0x0000000B)\r
4187f79c ZC	31	#define EV_COMPACT_HASH ((TCG_EVENTTYPE) 0x0000000C)\r
	32	#define EV_NONHOST_CODE ((TCG_EVENTTYPE) 0x0000000F)\r
	33	#define EV_NONHOST_CONFIG ((TCG_EVENTTYPE) 0x00000010)\r
	34	#define EV_NONHOST_INFO ((TCG_EVENTTYPE) 0x00000011)\r
	35	#define EV_OMIT_BOOT_DEVICE_EVENTS ((TCG_EVENTTYPE) 0x00000012)\r
267669ba LG	36	\r
	37	//\r
	38	// EFI specific event types\r
	39	//\r
2f88bd3a MK	40	#define EV_EFI_EVENT_BASE ((TCG_EVENTTYPE) 0x80000000)\r
	41	#define EV_EFI_VARIABLE_DRIVER_CONFIG (EV_EFI_EVENT_BASE + 1)\r
	42	#define EV_EFI_VARIABLE_BOOT (EV_EFI_EVENT_BASE + 2)\r
	43	#define EV_EFI_BOOT_SERVICES_APPLICATION (EV_EFI_EVENT_BASE + 3)\r
	44	#define EV_EFI_BOOT_SERVICES_DRIVER (EV_EFI_EVENT_BASE + 4)\r
	45	#define EV_EFI_RUNTIME_SERVICES_DRIVER (EV_EFI_EVENT_BASE + 5)\r
	46	#define EV_EFI_GPT_EVENT (EV_EFI_EVENT_BASE + 6)\r
	47	#define EV_EFI_ACTION (EV_EFI_EVENT_BASE + 7)\r
	48	#define EV_EFI_PLATFORM_FIRMWARE_BLOB (EV_EFI_EVENT_BASE + 8)\r
	49	#define EV_EFI_HANDOFF_TABLES (EV_EFI_EVENT_BASE + 9)\r
	50	#define EV_EFI_PLATFORM_FIRMWARE_BLOB2 (EV_EFI_EVENT_BASE + 0xA)\r
	51	#define EV_EFI_HANDOFF_TABLES2 (EV_EFI_EVENT_BASE + 0xB)\r
	52	#define EV_EFI_HCRTM_EVENT (EV_EFI_EVENT_BASE + 0x10)\r
	53	#define EV_EFI_VARIABLE_AUTHORITY (EV_EFI_EVENT_BASE + 0xE0)\r
	54	#define EV_EFI_SPDM_FIRMWARE_BLOB (EV_EFI_EVENT_BASE + 0xE1)\r
	55	#define EV_EFI_SPDM_FIRMWARE_CONFIG (EV_EFI_EVENT_BASE + 0xE2)\r
267669ba	56	\r
267669ba LG	57	#define EFI_CALLING_EFI_APPLICATION \\r
267669ba LG	58	"Calling EFI Application from Boot Option"\r
341d442c BB	59	#define EFI_RETURNING_FROM_EFI_APPLICATION \\r
341d442c BB	60	"Returning from EFI Application from Boot Option"\r
267669ba LG	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
2f88bd3a MK	68	#define EV_POSTCODE_INFO_POST_CODE "POST CODE"\r
2f88bd3a MK	69	#define POST_CODE_STR_LEN (sizeof(EV_POSTCODE_INFO_POST_CODE) - 1)\r
2096185d	70	\r
2f88bd3a MK	71	#define EV_POSTCODE_INFO_SMM_CODE "SMM CODE"\r
2f88bd3a MK	72	#define SMM_CODE_STR_LEN (sizeof(EV_POSTCODE_INFO_SMM_CODE) - 1)\r
2096185d	73	\r
2f88bd3a MK	74	#define EV_POSTCODE_INFO_ACPI_DATA "ACPI DATA"\r
2f88bd3a MK	75	#define ACPI_DATA_LEN (sizeof(EV_POSTCODE_INFO_ACPI_DATA) - 1)\r
2096185d	76	\r
2f88bd3a MK	77	#define EV_POSTCODE_INFO_BIS_CODE "BIS CODE"\r
2f88bd3a MK	78	#define BIS_CODE_LEN (sizeof(EV_POSTCODE_INFO_BIS_CODE) - 1)\r
2096185d	79	\r
2f88bd3a MK	80	#define EV_POSTCODE_INFO_UEFI_PI "UEFI PI"\r
2f88bd3a MK	81	#define UEFI_PI_LEN (sizeof(EV_POSTCODE_INFO_UEFI_PI) - 1)\r
2096185d	82	\r
2f88bd3a MK	83	#define EV_POSTCODE_INFO_OPROM "Embedded Option ROM"\r
2f88bd3a MK	84	#define OPROM_LEN (sizeof(EV_POSTCODE_INFO_OPROM) - 1)\r
2096185d	85	\r
ec8c74e8 JY	86	#define EV_POSTCODE_INFO_EMBEDDED_UEFI_DRIVER "Embedded UEFI Driver"\r
	87	#define EMBEDDED_UEFI_DRIVER_LEN (sizeof(EV_POSTCODE_INFO_EMBEDDED_UEFI_DRIVER) - 1)\r
	88	\r
59b226d6 JY	89	#define FIRMWARE_DEBUGGER_EVENT_STRING "UEFI Debug Mode"\r
	90	#define FIRMWARE_DEBUGGER_EVENT_STRING_LEN (sizeof(FIRMWARE_DEBUGGER_EVENT_STRING) - 1)\r
	91	\r
267669ba LG	92	//\r
	93	// Set structure alignment to 1-byte\r
	94	//\r
a04ad3f0	95	#pragma pack (1)\r
267669ba	96	\r
2f88bd3a MK	97	typedef UINT32 TCG_EVENTTYPE;\r
	98	typedef TPM_PCRINDEX TCG_PCRINDEX;\r
	99	typedef TPM_DIGEST TCG_DIGEST;\r
fb5148a0	100	///\r
3ed785e9	101	/// Event Log Entry Structure Definition\r
fb5148a0	102	///\r
267669ba	103	typedef struct tdTCG_PCR_EVENT {\r
2f88bd3a MK	104	TCG_PCRINDEX PCRIndex; ///< PCRIndex event extended to\r
	105	TCG_EVENTTYPE EventType; ///< TCG EFI event type\r
	106	TCG_DIGEST Digest; ///< Value extended into PCRIndex\r
	107	UINT32 EventSize; ///< Size of the event data\r
	108	UINT8 Event[1]; ///< The event data\r
267669ba LG	109	} TCG_PCR_EVENT;\r
267669ba LG	110	\r
2f88bd3a	111	#define TSS_EVENT_DATA_MAX_SIZE 256\r
3ed785e9	112	\r
fb5148a0	113	///\r
	114	/// TCG_PCR_EVENT_HDR\r
	115	///\r
267669ba	116	typedef struct tdTCG_PCR_EVENT_HDR {\r
2f88bd3a MK	117	TCG_PCRINDEX PCRIndex;\r
	118	TCG_EVENTTYPE EventType;\r
	119	TCG_DIGEST Digest;\r
	120	UINT32 EventSize;\r
267669ba LG	121	} TCG_PCR_EVENT_HDR;\r
267669ba LG	122	\r
fb5148a0	123	///\r
	124	/// EFI_PLATFORM_FIRMWARE_BLOB\r
	125	///\r
	126	/// BlobLength should be of type UINTN but we use UINT64 here\r
	127	/// because PEI is 32-bit while DXE is 64-bit on x64 platforms\r
	128	///\r
267669ba	129	typedef struct tdEFI_PLATFORM_FIRMWARE_BLOB {\r
2f88bd3a MK	130	EFI_PHYSICAL_ADDRESS BlobBase;\r
2f88bd3a MK	131	UINT64 BlobLength;\r
267669ba LG	132	} EFI_PLATFORM_FIRMWARE_BLOB;\r
267669ba LG	133	\r
ec8c74e8 JY	134	///\r
	135	/// UEFI_PLATFORM_FIRMWARE_BLOB\r
	136	///\r
	137	/// This structure is used in EV_EFI_PLATFORM_FIRMWARE_BLOB\r
	138	/// event to facilitate the measurement of firmware volume.\r
	139	///\r
	140	typedef struct tdUEFI_PLATFORM_FIRMWARE_BLOB {\r
2f88bd3a MK	141	EFI_PHYSICAL_ADDRESS BlobBase;\r
2f88bd3a MK	142	UINT64 BlobLength;\r
ec8c74e8 JY	143	} UEFI_PLATFORM_FIRMWARE_BLOB;\r
	144	\r
	145	///\r
	146	/// UEFI_PLATFORM_FIRMWARE_BLOB2\r
	147	///\r
	148	/// This structure is used in EV_EFI_PLATFORM_FIRMWARE_BLOB2\r
	149	/// event to facilitate the measurement of firmware volume.\r
	150	///\r
	151	typedef struct tdUEFI_PLATFORM_FIRMWARE_BLOB2 {\r
2f88bd3a MK	152	UINT8 BlobDescriptionSize;\r
	153	// UINT8 BlobDescription[BlobDescriptionSize];\r
	154	// EFI_PHYSICAL_ADDRESS BlobBase;\r
	155	// UINT64 BlobLength;\r
ec8c74e8 JY	156	} UEFI_PLATFORM_FIRMWARE_BLOB2;\r
ec8c74e8 JY	157	\r
fb5148a0	158	///\r
	159	/// EFI_IMAGE_LOAD_EVENT\r
	160	///\r
	161	/// This structure is used in EV_EFI_BOOT_SERVICES_APPLICATION,\r
	162	/// EV_EFI_BOOT_SERVICES_DRIVER and EV_EFI_RUNTIME_SERVICES_DRIVER\r
	163	///\r
267669ba	164	typedef struct tdEFI_IMAGE_LOAD_EVENT {\r
2f88bd3a MK	165	EFI_PHYSICAL_ADDRESS ImageLocationInMemory;\r
	166	UINTN ImageLengthInMemory;\r
	167	UINTN ImageLinkTimeAddress;\r
	168	UINTN LengthOfDevicePath;\r
	169	EFI_DEVICE_PATH_PROTOCOL DevicePath[1];\r
267669ba LG	170	} EFI_IMAGE_LOAD_EVENT;\r
267669ba LG	171	\r
ec8c74e8 JY	172	///\r
	173	/// UEFI_IMAGE_LOAD_EVENT\r
	174	///\r
	175	/// This structure is used in EV_EFI_BOOT_SERVICES_APPLICATION,\r
	176	/// EV_EFI_BOOT_SERVICES_DRIVER and EV_EFI_RUNTIME_SERVICES_DRIVER\r
	177	///\r
	178	typedef struct tdUEFI_IMAGE_LOAD_EVENT {\r
2f88bd3a MK	179	EFI_PHYSICAL_ADDRESS ImageLocationInMemory;\r
	180	UINT64 ImageLengthInMemory;\r
	181	UINT64 ImageLinkTimeAddress;\r
	182	UINT64 LengthOfDevicePath;\r
	183	EFI_DEVICE_PATH_PROTOCOL DevicePath[1];\r
ec8c74e8 JY	184	} UEFI_IMAGE_LOAD_EVENT;\r
ec8c74e8 JY	185	\r
fb5148a0	186	///\r
	187	/// EFI_HANDOFF_TABLE_POINTERS\r
	188	///\r
	189	/// This structure is used in EV_EFI_HANDOFF_TABLES event to facilitate\r
	190	/// the measurement of given configuration tables.\r
	191	///\r
267669ba	192	typedef struct tdEFI_HANDOFF_TABLE_POINTERS {\r
2f88bd3a MK	193	UINTN NumberOfTables;\r
2f88bd3a MK	194	EFI_CONFIGURATION_TABLE TableEntry[1];\r
267669ba LG	195	} EFI_HANDOFF_TABLE_POINTERS;\r
267669ba LG	196	\r
ec8c74e8 JY	197	///\r
	198	/// UEFI_HANDOFF_TABLE_POINTERS\r
	199	///\r
	200	/// This structure is used in EV_EFI_HANDOFF_TABLES event to facilitate\r
	201	/// the measurement of given configuration tables.\r
	202	///\r
	203	typedef struct tdUEFI_HANDOFF_TABLE_POINTERS {\r
2f88bd3a MK	204	UINT64 NumberOfTables;\r
2f88bd3a MK	205	EFI_CONFIGURATION_TABLE TableEntry[1];\r
ec8c74e8 JY	206	} UEFI_HANDOFF_TABLE_POINTERS;\r
	207	\r
	208	///\r
	209	/// UEFI_HANDOFF_TABLE_POINTERS2\r
	210	///\r
	211	/// This structure is used in EV_EFI_HANDOFF_TABLES2 event to facilitate\r
	212	/// the measurement of given configuration tables.\r
	213	///\r
	214	typedef struct tdUEFI_HANDOFF_TABLE_POINTERS2 {\r
2f88bd3a MK	215	UINT8 TableDescriptionSize;\r
	216	// UINT8 TableDescription[TableDescriptionSize];\r
	217	// UINT64 NumberOfTables;\r
	218	// EFI_CONFIGURATION_TABLE TableEntry[1];\r
ec8c74e8 JY	219	} UEFI_HANDOFF_TABLE_POINTERS2;\r
ec8c74e8 JY	220	\r
fb5148a0	221	///\r
	222	/// EFI_VARIABLE_DATA\r
	223	///\r
	224	/// This structure serves as the header for measuring variables. The name of the\r
	225	/// variable (in Unicode format) should immediately follow, then the variable\r
	226	/// data.\r
49945882	227	/// This is defined in TCG EFI Platform Spec for TPM1.1 or 1.2 V1.22\r
fb5148a0	228	///\r
267669ba	229	typedef struct tdEFI_VARIABLE_DATA {\r
2f88bd3a MK	230	EFI_GUID VariableName;\r
	231	UINTN UnicodeNameLength;\r
	232	UINTN VariableDataLength;\r
	233	CHAR16 UnicodeName[1];\r
	234	INT8 VariableData[1]; ///< Driver or platform-specific data\r
267669ba LG	235	} EFI_VARIABLE_DATA;\r
267669ba LG	236	\r
49945882 ZC	237	///\r
	238	/// UEFI_VARIABLE_DATA\r
	239	///\r
	240	/// This structure serves as the header for measuring variables. The name of the\r
	241	/// variable (in Unicode format) should immediately follow, then the variable\r
	242	/// data.\r
	243	/// This is defined in TCG PC Client Firmware Profile Spec 00.21\r
	244	///\r
	245	typedef struct tdUEFI_VARIABLE_DATA {\r
2f88bd3a MK	246	EFI_GUID VariableName;\r
	247	UINT64 UnicodeNameLength;\r
	248	UINT64 VariableDataLength;\r
	249	CHAR16 UnicodeName[1];\r
	250	INT8 VariableData[1]; ///< Driver or platform-specific data\r
49945882 ZC	251	} UEFI_VARIABLE_DATA;\r
49945882 ZC	252	\r
59b226d6 JY	253	//\r
	254	// For TrEE1.0 compatibility\r
	255	//\r
	256	typedef struct {\r
2f88bd3a MK	257	EFI_GUID VariableName;\r
	258	UINT64 UnicodeNameLength; // The TCG Definition used UINTN\r
	259	UINT64 VariableDataLength; // The TCG Definition used UINTN\r
	260	CHAR16 UnicodeName[1];\r
	261	INT8 VariableData[1];\r
59b226d6 JY	262	} EFI_VARIABLE_DATA_TREE;\r
59b226d6 JY	263	\r
267669ba	264	typedef struct tdEFI_GPT_DATA {\r
2f88bd3a MK	265	EFI_PARTITION_TABLE_HEADER EfiPartitionHeader;\r
	266	UINTN NumberOfPartitions;\r
	267	EFI_PARTITION_ENTRY Partitions[1];\r
267669ba LG	268	} EFI_GPT_DATA;\r
267669ba LG	269	\r
ec8c74e8	270	typedef struct tdUEFI_GPT_DATA {\r
2f88bd3a MK	271	EFI_PARTITION_TABLE_HEADER EfiPartitionHeader;\r
	272	UINT64 NumberOfPartitions;\r
	273	EFI_PARTITION_ENTRY Partitions[1];\r
ec8c74e8 JY	274	} UEFI_GPT_DATA;\r
ec8c74e8 JY	275	\r
2f88bd3a MK	276	#define TCG_DEVICE_SECURITY_EVENT_DATA_SIGNATURE "SPDM Device Sec"\r
2f88bd3a MK	277	#define TCG_DEVICE_SECURITY_EVENT_DATA_VERSION 1\r
ec8c74e8 JY	278	\r
	279	#define TCG_DEVICE_SECURITY_EVENT_DATA_DEVICE_TYPE_NULL 0\r
	280	#define TCG_DEVICE_SECURITY_EVENT_DATA_DEVICE_TYPE_PCI 1\r
	281	#define TCG_DEVICE_SECURITY_EVENT_DATA_DEVICE_TYPE_USB 2\r
	282	\r
	283	///\r
	284	/// TCG_DEVICE_SECURITY_EVENT_DATA_HEADER\r
	285	/// This is the header of TCG_DEVICE_SECURITY_EVENT_DATA, which is\r
	286	/// used in EV_EFI_SPDM_FIRMWARE_BLOB and EV_EFI_SPDM_FIRMWARE_CONFIG.\r
	287	///\r
	288	typedef struct {\r
2f88bd3a MK	289	UINT8 Signature[16];\r
	290	UINT16 Version;\r
	291	UINT16 Length;\r
	292	UINT32 SpdmHashAlgo;\r
	293	UINT32 DeviceType;\r
	294	// SPDM_MEASUREMENT_BLOCK SpdmMeasurementBlock;\r
ec8c74e8 JY	295	} TCG_DEVICE_SECURITY_EVENT_DATA_HEADER;\r
	296	\r
	297	#define TCG_DEVICE_SECURITY_EVENT_DATA_PCI_CONTEXT_VERSION 0\r
	298	\r
	299	///\r
	300	/// TCG_DEVICE_SECURITY_EVENT_DATA_PCI_CONTEXT\r
	301	/// This is the PCI context data of TCG_DEVICE_SECURITY_EVENT_DATA, which is\r
	302	/// used in EV_EFI_SPDM_FIRMWARE_BLOB and EV_EFI_SPDM_FIRMWARE_CONFIG.\r
	303	///\r
	304	typedef struct {\r
2f88bd3a MK	305	UINT16 Version;\r
	306	UINT16 Length;\r
	307	UINT16 VendorId;\r
	308	UINT16 DeviceId;\r
	309	UINT8 RevisionID;\r
	310	UINT8 ClassCode[3];\r
	311	UINT16 SubsystemVendorID;\r
	312	UINT16 SubsystemID;\r
ec8c74e8 JY	313	} TCG_DEVICE_SECURITY_EVENT_DATA_PCI_CONTEXT;\r
	314	\r
	315	#define TCG_DEVICE_SECURITY_EVENT_DATA_USB_CONTEXT_VERSION 0\r
	316	\r
	317	///\r
	318	/// TCG_DEVICE_SECURITY_EVENT_DATA_USB_CONTEXT\r
	319	/// This is the USB context data of TCG_DEVICE_SECURITY_EVENT_DATA, which is\r
	320	/// used in EV_EFI_SPDM_FIRMWARE_BLOB and EV_EFI_SPDM_FIRMWARE_CONFIG.\r
	321	///\r
	322	typedef struct {\r
2f88bd3a MK	323	UINT16 Version;\r
	324	UINT16 Length;\r
	325	// UINT8 DeviceDescriptor[DescLen];\r
	326	// UINT8 BodDescriptor[DescLen];\r
	327	// UINT8 ConfigurationDescriptor[DescLen][NumOfConfiguration];\r
ec8c74e8 JY	328	} TCG_DEVICE_SECURITY_EVENT_DATA_USB_CONTEXT;\r
ec8c74e8 JY	329	\r
59b226d6 JY	330	//\r
	331	// Crypto Agile Log Entry Format\r
	332	//\r
	333	typedef struct tdTCG_PCR_EVENT2 {\r
2f88bd3a MK	334	TCG_PCRINDEX PCRIndex;\r
	335	TCG_EVENTTYPE EventType;\r
	336	TPML_DIGEST_VALUES Digest;\r
	337	UINT32 EventSize;\r
	338	UINT8 Event[1];\r
59b226d6 JY	339	} TCG_PCR_EVENT2;\r
59b226d6 JY	340	\r
c5647c6c ZC	341	//\r
	342	// TCG PCR Event2 Header\r
	343	// Follow TCG EFI Protocol Spec 5.2 Crypto Agile Log Entry Format\r
	344	//\r
2f88bd3a MK	345	typedef struct tdTCG_PCR_EVENT2_HDR {\r
	346	TCG_PCRINDEX PCRIndex;\r
	347	TCG_EVENTTYPE EventType;\r
	348	TPML_DIGEST_VALUES Digests;\r
	349	UINT32 EventSize;\r
c5647c6c ZC	350	} TCG_PCR_EVENT2_HDR;\r
c5647c6c ZC	351	\r
59b226d6 JY	352	//\r
	353	// Log Header Entry Data\r
	354	//\r
	355	typedef struct {\r
	356	//\r
	357	// TCG defined hashing algorithm ID.\r
	358	//\r
2f88bd3a	359	UINT16 algorithmId;\r
59b226d6 JY	360	//\r
	361	// The size of the digest for the respective hashing algorithm.\r
	362	//\r
2f88bd3a	363	UINT16 digestSize;\r
59b226d6 JY	364	} TCG_EfiSpecIdEventAlgorithmSize;\r
59b226d6 JY	365	\r
2f88bd3a MK	366	#define TCG_EfiSpecIDEventStruct_SIGNATURE_02 "Spec ID Event02"\r
2f88bd3a MK	367	#define TCG_EfiSpecIDEventStruct_SIGNATURE_03 "Spec ID Event03"\r
59b226d6	368	\r
2f88bd3a MK	369	#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM12 1\r
	370	#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM12 2\r
	371	#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM12 2\r
59b226d6 JY	372	\r
	373	#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM2 2\r
	374	#define TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM2 0\r
	375	#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2 0\r
ec8c74e8	376	#define TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2_REV_105 105\r
59b226d6 JY	377	\r
59b226d6 JY	378	typedef struct {\r
2f88bd3a	379	UINT8 signature[16];\r
59b226d6 JY	380	//\r
	381	// The value for the Platform Class.\r
	382	// The enumeration is defined in the TCG ACPI Specification Client Common Header.\r
	383	//\r
2f88bd3a	384	UINT32 platformClass;\r
59b226d6 JY	385	//\r
	386	// The TCG EFI Platform Specification minor version number this BIOS supports.\r
	387	// Any BIOS supporting version (1.22) MUST set this value to 02h.\r
	388	// Any BIOS supporting version (2.0) SHALL set this value to 0x00.\r
	389	//\r
2f88bd3a	390	UINT8 specVersionMinor;\r
59b226d6 JY	391	//\r
	392	// The TCG EFI Platform Specification major version number this BIOS supports.\r
	393	// Any BIOS supporting version (1.22) MUST set this value to 01h.\r
	394	// Any BIOS supporting version (2.0) SHALL set this value to 0x02.\r
	395	//\r
2f88bd3a	396	UINT8 specVersionMajor;\r
59b226d6 JY	397	//\r
	398	// The TCG EFI Platform Specification errata for this specification this BIOS supports.\r
	399	// Any BIOS supporting version and errata (1.22) MUST set this value to 02h.\r
	400	// Any BIOS supporting version and errata (2.0) SHALL set this value to 0x00.\r
	401	//\r
2f88bd3a	402	UINT8 specErrata;\r
59b226d6 JY	403	//\r
	404	// Specifies the size of the UINTN fields used in various data structures used in this specification.\r
	405	// 0x01 indicates UINT32 and 0x02 indicates UINT64.\r
	406	//\r
2f88bd3a	407	UINT8 uintnSize;\r
59b226d6 JY	408	//\r
	409	// This field is added in "Spec ID Event03".\r
	410	// The number of hashing algorithms used in this event log (except the first event).\r
	411	// All events in this event log use all hashing algorithms defined here.\r
	412	//\r
2f88bd3a	413	// UINT32 numberOfAlgorithms;\r
59b226d6 JY	414	//\r
	415	// This field is added in "Spec ID Event03".\r
	416	// An array of size numberOfAlgorithms of value pairs.\r
	417	//\r
2f88bd3a	418	// TCG_EfiSpecIdEventAlgorithmSize digestSize[numberOfAlgorithms];\r
59b226d6 JY	419	//\r
	420	// Size in bytes of the VendorInfo field.\r
	421	// Maximum value SHALL be FFh bytes.\r
	422	//\r
2f88bd3a	423	// UINT8 vendorInfoSize;\r
59b226d6 JY	424	//\r
	425	// Provided for use by the BIOS implementer.\r
	426	// The value might be used, for example, to provide more detailed information about the specific BIOS such as BIOS revision numbers, etc.\r
	427	// The values within this field are not standardized and are implementer-specific.\r
	428	// Platform-specific or -unique information SHALL NOT be provided in this field.\r
	429	//\r
2f88bd3a	430	// UINT8 vendorInfo[vendorInfoSize];\r
59b226d6 JY	431	} TCG_EfiSpecIDEventStruct;\r
59b226d6 JY	432	\r
ec8c74e8	433	typedef struct tdTCG_PCClientTaggedEvent {\r
2f88bd3a MK	434	UINT32 taggedEventID;\r
	435	UINT32 taggedEventDataSize;\r
	436	// UINT8 taggedEventData[taggedEventDataSize];\r
ec8c74e8 JY	437	} TCG_PCClientTaggedEvent;\r
ec8c74e8 JY	438	\r
2f88bd3a MK	439	#define TCG_Sp800_155_PlatformId_Event_SIGNATURE "SP800-155 Event"\r
2f88bd3a MK	440	#define TCG_Sp800_155_PlatformId_Event2_SIGNATURE "SP800-155 Event2"\r
6671cd74	441	\r
ec8c74e8	442	typedef struct tdTCG_Sp800_155_PlatformId_Event2 {\r
2f88bd3a	443	UINT8 Signature[16];\r
ec8c74e8 JY	444	//\r
	445	// Where Vendor ID is an integer defined\r
	446	// at http://www.iana.org/assignments/enterprisenumbers\r
	447	//\r
2f88bd3a	448	UINT32 VendorId;\r
ec8c74e8 JY	449	//\r
	450	// 16-byte identifier of a given platform's static configuration of code\r
	451	//\r
2f88bd3a	452	EFI_GUID ReferenceManifestGuid;\r
ec8c74e8 JY	453	//\r
	454	// Below structure is newly added in TCG_Sp800_155_PlatformId_Event2.\r
	455	//\r
2f88bd3a MK	456	// UINT8 PlatformManufacturerStrSize;\r
	457	// UINT8 PlatformManufacturerStr[PlatformManufacturerStrSize];\r
	458	// UINT8 PlatformModelSize;\r
	459	// UINT8 PlatformModel[PlatformModelSize];\r
	460	// UINT8 PlatformVersionSize;\r
	461	// UINT8 PlatformVersion[PlatformVersionSize];\r
	462	// UINT8 PlatformModelSize;\r
	463	// UINT8 PlatformModel[PlatformModelSize];\r
	464	// UINT8 FirmwareManufacturerStrSize;\r
	465	// UINT8 FirmwareManufacturerStr[FirmwareManufacturerStrSize];\r
	466	// UINT32 FirmwareManufacturerId;\r
	467	// UINT8 FirmwareVersion;\r
	468	// UINT8 FirmwareVersion[FirmwareVersionSize]];\r
ec8c74e8	469	} TCG_Sp800_155_PlatformId_Event2;\r
6671cd74	470	\r
2f88bd3a	471	#define TCG_EfiStartupLocalityEvent_SIGNATURE "StartupLocality"\r
6671cd74 ZC	472	\r
6671cd74 ZC	473	//\r
ec8c74e8	474	// The Locality Indicator which sent the TPM2_Startup command\r
6671cd74	475	//\r
2f88bd3a MK	476	#define LOCALITY_0_INDICATOR 0x00\r
2f88bd3a MK	477	#define LOCALITY_3_INDICATOR 0x03\r
6671cd74 ZC	478	\r
	479	//\r
	480	// Startup Locality Event\r
	481	//\r
2f88bd3a MK	482	typedef struct tdTCG_EfiStartupLocalityEvent {\r
2f88bd3a MK	483	UINT8 Signature[16];\r
6671cd74 ZC	484	//\r
	485	// The Locality Indicator which sent the TPM2_Startup command\r
	486	//\r
2f88bd3a	487	UINT8 StartupLocality;\r
6671cd74 ZC	488	} TCG_EfiStartupLocalityEvent;\r
6671cd74 ZC	489	\r
267669ba LG	490	//\r
	491	// Restore original structure alignment\r
	492	//\r
a04ad3f0	493	#pragma pack ()\r
267669ba LG	494	\r
267669ba LG	495	#endif\r