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

/** @file\r
  TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final\r
\r
  Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __UEFI_TCG_PLATFORM_H__\r
#define __UEFI_TCG_PLATFORM_H__\r
\r
#include <IndustryStandard/Tpm12.h>\r
#include <Uefi.h>\r
\r
//\r
// Standard event types\r
//\r
#define EV_POST_CODE                ((TCG_EVENTTYPE) 0x00000001)\r
#define EV_SEPARATOR                ((TCG_EVENTTYPE) 0x00000004)\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
\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
\r
#define EFI_CALLING_EFI_APPLICATION         \\r
  "Calling EFI Application from Boot Option"\r
#define EFI_RETURNING_FROM_EFI_APPLICATOIN  \\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
\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
//\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
/// 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
/// 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
/// 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
///\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
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
//\r
// Restore original structure alignment\r
//\r
#pragma pack ()\r
\r
#endif\r
\r
\r
Commit	Line	Data
c311f86b	1	/** @file\r
267669ba LG	2	TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final\r
267669ba LG	3	\r
04a89420	4	Copyright (c) 2006 - 2012, 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
267669ba LG	18	#include <IndustryStandard/Tpm12.h>\r
a979fca9	19	#include <Uefi.h>\r
1fd83dd2	20	\r
267669ba LG	21	//\r
	22	// Standard event types\r
	23	//\r
	24	#define EV_POST_CODE ((TCG_EVENTTYPE) 0x00000001)\r
	25	#define EV_SEPARATOR ((TCG_EVENTTYPE) 0x00000004)\r
	26	#define EV_S_CRTM_CONTENTS ((TCG_EVENTTYPE) 0x00000007)\r
	27	#define EV_S_CRTM_VERSION ((TCG_EVENTTYPE) 0x00000008)\r
04a89420	28	#define EV_CPU_MICROCODE ((TCG_EVENTTYPE) 0x00000009)\r
267669ba LG	29	\r
	30	//\r
	31	// EFI specific event types\r
	32	//\r
	33	#define EV_EFI_EVENT_BASE ((TCG_EVENTTYPE) 0x80000000)\r
	34	#define EV_EFI_VARIABLE_DRIVER_CONFIG (EV_EFI_EVENT_BASE + 1)\r
	35	#define EV_EFI_VARIABLE_BOOT (EV_EFI_EVENT_BASE + 2)\r
	36	#define EV_EFI_BOOT_SERVICES_APPLICATION (EV_EFI_EVENT_BASE + 3)\r
	37	#define EV_EFI_BOOT_SERVICES_DRIVER (EV_EFI_EVENT_BASE + 4)\r
	38	#define EV_EFI_RUNTIME_SERVICES_DRIVER (EV_EFI_EVENT_BASE + 5)\r
	39	#define EV_EFI_GPT_EVENT (EV_EFI_EVENT_BASE + 6)\r
	40	#define EV_EFI_ACTION (EV_EFI_EVENT_BASE + 7)\r
	41	#define EV_EFI_PLATFORM_FIRMWARE_BLOB (EV_EFI_EVENT_BASE + 8)\r
	42	#define EV_EFI_HANDOFF_TABLES (EV_EFI_EVENT_BASE + 9)\r
	43	\r
267669ba LG	44	#define EFI_CALLING_EFI_APPLICATION \\r
	45	"Calling EFI Application from Boot Option"\r
	46	#define EFI_RETURNING_FROM_EFI_APPLICATOIN \\r
	47	"Returning from EFI Application from Boot Option"\r
	48	#define EFI_EXIT_BOOT_SERVICES_INVOCATION \\r
	49	"Exit Boot Services Invocation"\r
	50	#define EFI_EXIT_BOOT_SERVICES_FAILED \\r
	51	"Exit Boot Services Returned with Failure"\r
	52	#define EFI_EXIT_BOOT_SERVICES_SUCCEEDED \\r
	53	"Exit Boot Services Returned with Success"\r
	54	\r
2096185d	55	\r
	56	#define EV_POSTCODE_INFO_POST_CODE "POST CODE"\r
	57	#define POST_CODE_STR_LEN (sizeof(EV_POSTCODE_INFO_POST_CODE) - 1)\r
	58	\r
	59	#define EV_POSTCODE_INFO_SMM_CODE "SMM CODE"\r
	60	#define SMM_CODE_STR_LEN (sizeof(EV_POSTCODE_INFO_SMM_CODE) - 1)\r
	61	\r
	62	#define EV_POSTCODE_INFO_ACPI_DATA "ACPI DATA"\r
	63	#define ACPI_DATA_LEN (sizeof(EV_POSTCODE_INFO_ACPI_DATA) - 1)\r
	64	\r
	65	#define EV_POSTCODE_INFO_BIS_CODE "BIS CODE"\r
	66	#define BIS_CODE_LEN (sizeof(EV_POSTCODE_INFO_BIS_CODE) - 1)\r
	67	\r
	68	#define EV_POSTCODE_INFO_UEFI_PI "UEFI PI"\r
	69	#define UEFI_PI_LEN (sizeof(EV_POSTCODE_INFO_UEFI_PI) - 1)\r
	70	\r
	71	#define EV_POSTCODE_INFO_OPROM "Embedded Option ROM"\r
	72	#define OPROM_LEN (sizeof(EV_POSTCODE_INFO_OPROM) - 1)\r
	73	\r
267669ba LG	74	//\r
	75	// Set structure alignment to 1-byte\r
	76	//\r
a04ad3f0	77	#pragma pack (1)\r
267669ba LG	78	\r
267669ba LG	79	typedef UINT32 TCG_EVENTTYPE;\r
992f22b9 LG	80	typedef TPM_PCRINDEX TCG_PCRINDEX;\r
992f22b9 LG	81	typedef TPM_DIGEST TCG_DIGEST;\r
fb5148a0	82	///\r
3ed785e9	83	/// Event Log Entry Structure Definition\r
fb5148a0	84	///\r
267669ba	85	typedef struct tdTCG_PCR_EVENT {\r
3ed785e9	86	TCG_PCRINDEX PCRIndex; ///< PCRIndex event extended to\r
	87	TCG_EVENTTYPE EventType; ///< TCG EFI event type\r
	88	TCG_DIGEST Digest; ///< Value extended into PCRIndex\r
	89	UINT32 EventSize; ///< Size of the event data\r
	90	UINT8 Event[1]; ///< The event data\r
267669ba LG	91	} TCG_PCR_EVENT;\r
267669ba LG	92	\r
3ed785e9	93	#define TSS_EVENT_DATA_MAX_SIZE 256\r
3ed785e9	94	\r
fb5148a0	95	///\r
	96	/// TCG_PCR_EVENT_HDR\r
	97	///\r
267669ba LG	98	typedef struct tdTCG_PCR_EVENT_HDR {\r
	99	TCG_PCRINDEX PCRIndex;\r
	100	TCG_EVENTTYPE EventType;\r
	101	TCG_DIGEST Digest;\r
	102	UINT32 EventSize;\r
	103	} TCG_PCR_EVENT_HDR;\r
	104	\r
fb5148a0	105	///\r
	106	/// EFI_PLATFORM_FIRMWARE_BLOB\r
	107	///\r
	108	/// BlobLength should be of type UINTN but we use UINT64 here\r
	109	/// because PEI is 32-bit while DXE is 64-bit on x64 platforms\r
	110	///\r
267669ba LG	111	typedef struct tdEFI_PLATFORM_FIRMWARE_BLOB {\r
	112	EFI_PHYSICAL_ADDRESS BlobBase;\r
	113	UINT64 BlobLength;\r
	114	} EFI_PLATFORM_FIRMWARE_BLOB;\r
	115	\r
fb5148a0	116	///\r
	117	/// EFI_IMAGE_LOAD_EVENT\r
	118	///\r
	119	/// This structure is used in EV_EFI_BOOT_SERVICES_APPLICATION,\r
	120	/// EV_EFI_BOOT_SERVICES_DRIVER and EV_EFI_RUNTIME_SERVICES_DRIVER\r
	121	///\r
267669ba LG	122	typedef struct tdEFI_IMAGE_LOAD_EVENT {\r
	123	EFI_PHYSICAL_ADDRESS ImageLocationInMemory;\r
	124	UINTN ImageLengthInMemory;\r
	125	UINTN ImageLinkTimeAddress;\r
	126	UINTN LengthOfDevicePath;\r
	127	EFI_DEVICE_PATH_PROTOCOL DevicePath[1];\r
	128	} EFI_IMAGE_LOAD_EVENT;\r
	129	\r
fb5148a0	130	///\r
	131	/// EFI_HANDOFF_TABLE_POINTERS\r
	132	///\r
	133	/// This structure is used in EV_EFI_HANDOFF_TABLES event to facilitate\r
	134	/// the measurement of given configuration tables.\r
	135	///\r
267669ba	136	typedef struct tdEFI_HANDOFF_TABLE_POINTERS {\r
3ed785e9	137	UINTN NumberOfTables;\r
267669ba LG	138	EFI_CONFIGURATION_TABLE TableEntry[1];\r
	139	} EFI_HANDOFF_TABLE_POINTERS;\r
	140	\r
fb5148a0	141	///\r
	142	/// EFI_VARIABLE_DATA\r
	143	///\r
	144	/// This structure serves as the header for measuring variables. The name of the\r
	145	/// variable (in Unicode format) should immediately follow, then the variable\r
	146	/// data.\r
	147	///\r
267669ba LG	148	typedef struct tdEFI_VARIABLE_DATA {\r
	149	EFI_GUID VariableName;\r
	150	UINTN UnicodeNameLength;\r
	151	UINTN VariableDataLength;\r
	152	CHAR16 UnicodeName[1];\r
3ed785e9	153	INT8 VariableData[1]; ///< Driver or platform-specific data\r
267669ba LG	154	} EFI_VARIABLE_DATA;\r
	155	\r
	156	typedef struct tdEFI_GPT_DATA {\r
	157	EFI_PARTITION_TABLE_HEADER EfiPartitionHeader;\r
	158	UINTN NumberOfPartitions; \r
	159	EFI_PARTITION_ENTRY Partitions[1];\r
	160	} EFI_GPT_DATA;\r
	161	\r
	162	//\r
	163	// Restore original structure alignment\r
	164	//\r
a04ad3f0	165	#pragma pack ()\r
267669ba LG	166	\r
	167	#endif\r
	168	\r
	169	\r