[mirror_edk2.git] / MdePkg / Include / Protocol / TrEEProtocol.h

/** @file\r
  Ihis protocol is defined to abstract TPM2 hardware access in boot phase.\r
\r
Copyright (c) 2013 - 2015, 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 __TREE_H__\r
#define __TREE_H__\r
\r
#include <IndustryStandard/UefiTcgPlatform.h>\r
#include <IndustryStandard/Tpm20.h>\r
\r
#define EFI_TREE_PROTOCOL_GUID \\r
  {0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f}\r
\r
typedef struct _EFI_TREE_PROTOCOL EFI_TREE_PROTOCOL;\r
\r
typedef struct _TREE_VERSION {\r
  UINT8 Major;\r
  UINT8 Minor;\r
} TREE_VERSION;\r
\r
typedef UINT32 TREE_EVENT_LOG_BITMAP;\r
typedef UINT32 TREE_EVENT_LOG_FORMAT;\r
\r
#define TREE_EVENT_LOG_FORMAT_TCG_1_2       0x00000001\r
\r
typedef struct _TREE_BOOT_SERVICE_CAPABILITY {\r
  //\r
  // Allocated size of the structure passed in \r
  //\r
  UINT8                 Size;\r
  //\r
  // Version of the TREE_BOOT_SERVICE_CAPABILITY structure itself.\r
  // For this version of the protocol, the Major version shall be set to 1\r
  // and the Minor version shall be set to 0. \r
  //\r
  TREE_VERSION          StructureVersion;\r
  //\r
  // Version of the TrEE protocol.\r
  // For this version of the protocol, the Major version shall be set to 1\r
  // and the Minor version shall be set to 0. \r
  //\r
  TREE_VERSION          ProtocolVersion;\r
  //\r
  // Supported hash algorithms\r
  //\r
  UINT32                HashAlgorithmBitmap;\r
  //\r
  // Bitmap of supported event log formats\r
  //\r
  TREE_EVENT_LOG_BITMAP SupportedEventLogs;\r
  //\r
  // False = TrEE not present \r
  //\r
  BOOLEAN               TrEEPresentFlag;\r
  //\r
  // Max size (in bytes) of a command that can be sent to the TrEE \r
  //\r
  UINT16                MaxCommandSize;\r
  //\r
  // Max size (in bytes) of a response that can be provided by the TrEE \r
  //\r
  UINT16                MaxResponseSize;\r
  //\r
  // 4-byte Vendor ID (see Trusted Computing Group, "TCG Vendor ID Registry,"\r
  // Version 1.0, Revision 0.1, August 31, 2007, "TPM Capabilities Vendor ID" section) \r
  //\r
  UINT32                ManufacturerID;\r
} TREE_BOOT_SERVICE_CAPABILITY_1_0;\r
\r
typedef TREE_BOOT_SERVICE_CAPABILITY_1_0 TREE_BOOT_SERVICE_CAPABILITY;\r
\r
#define TREE_BOOT_HASH_ALG_SHA1   0x00000001\r
#define TREE_BOOT_HASH_ALG_SHA256 0x00000002\r
#define TREE_BOOT_HASH_ALG_SHA384 0x00000004\r
#define TREE_BOOT_HASH_ALG_SHA512 0x00000008\r
\r
//\r
// This bit is shall be set when an event shall be extended but not logged.\r
//\r
#define TREE_EXTEND_ONLY  0x0000000000000001\r
//\r
// This bit shall be set when the intent is to measure a PE/COFF image.\r
//\r
#define PE_COFF_IMAGE     0x0000000000000010\r
\r
typedef UINT32 TrEE_PCRINDEX;\r
typedef UINT32 TrEE_EVENTTYPE;\r
\r
#define MAX_PCR_INDEX  23\r
#define TREE_EVENT_HEADER_VERSION  1\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  //\r
  // Size of the event header itself (sizeof(TrEE_EVENT_HEADER)). \r
  //\r
  UINT32            HeaderSize;\r
  //\r
  // Header version. For this version of this specification, the value shall be 1.\r
  //\r
  UINT16            HeaderVersion;\r
  //\r
  // Index of the PCR that shall be extended (0 - 23). \r
  //\r
  TrEE_PCRINDEX     PCRIndex;\r
  //\r
  // Type of the event that shall be extended (and optionally logged). \r
  //\r
  TrEE_EVENTTYPE    EventType;\r
} TrEE_EVENT_HEADER;\r
\r
typedef struct {\r
  //\r
  // Total size of the event including the Size component, the header and the Event data. \r
  //\r
  UINT32            Size;\r
  TrEE_EVENT_HEADER Header;\r
  UINT8             Event[1];\r
} TrEE_EVENT;\r
\r
#pragma pack()\r
\r
/**\r
  The EFI_TREE_PROTOCOL GetCapability function call provides protocol\r
  capability information and state information about the TrEE.\r
\r
  @param[in]  This               Indicates the calling context\r
  @param[out] ProtocolCapability The caller allocates memory for a TREE_BOOT_SERVICE_CAPABILITY\r
                                 structure and sets the size field to the size of the structure allocated.\r
                                 The callee fills in the fields with the EFI protocol capability information\r
                                 and the current TrEE state information up to the number of fields which\r
                                 fit within the size of the structure passed in.\r
\r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
                                 The ProtocolCapability variable will not be populated. \r
  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
                                 The ProtocolCapability variable will not be populated.\r
  @retval EFI_BUFFER_TOO_SMALL   The ProtocolCapability variable is too small to hold the full response.\r
                                 It will be partially populated (required Size field will be set). \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TREE_GET_CAPABILITY) (\r
  IN EFI_TREE_PROTOCOL                *This,\r
  IN OUT TREE_BOOT_SERVICE_CAPABILITY *ProtocolCapability\r
  );\r
\r
/**\r
  The EFI_TREE_PROTOCOL Get Event Log function call allows a caller to\r
  retrieve the address of a given event log and its last entry. \r
\r
  @param[in]  This               Indicates the calling context\r
  @param[in]  EventLogFormat     The type of the event log for which the information is requested.\r
  @param[out] EventLogLocation   A pointer to the memory address of the event log.\r
  @param[out] EventLogLastEntry  If the Event Log contains more than one entry, this is a pointer to the\r
                                 address of the start of the last entry in the event log in memory.\r
  @param[out] EventLogTruncated  If the Event Log is missing at least one entry because an event would\r
                                 have exceeded the area allocated for events, this value is set to TRUE.\r
                                 Otherwise, the value will be FALSE and the Event Log will be complete.\r
\r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect\r
                                 (e.g. asking for an event log whose format is not supported).\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TREE_GET_EVENT_LOG) (\r
  IN EFI_TREE_PROTOCOL     *This,\r
  IN TREE_EVENT_LOG_FORMAT EventLogFormat,\r
  OUT EFI_PHYSICAL_ADDRESS *EventLogLocation,\r
  OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry,\r
  OUT BOOLEAN              *EventLogTruncated\r
  );\r
\r
/**\r
  The EFI_TREE_PROTOCOL HashLogExtendEvent function call provides callers with\r
  an opportunity to extend and optionally log events without requiring\r
  knowledge of actual TPM commands. \r
  The extend operation will occur even if this function cannot create an event\r
  log entry (e.g. due to the event log being full). \r
\r
  @param[in]  This               Indicates the calling context\r
  @param[in]  Flags              Bitmap providing additional information.\r
  @param[in]  DataToHash         Physical address of the start of the data buffer to be hashed. \r
  @param[in]  DataToHashLen      The length in bytes of the buffer referenced by DataToHash.\r
  @param[in]  Event              Pointer to data buffer containing information about the event.\r
\r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_VOLUME_FULL        The extend operation occurred, but the event could not be written to one or more event logs.\r
  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
  @retval EFI_UNSUPPORTED        The PE/COFF image type is not supported.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_TREE_HASH_LOG_EXTEND_EVENT) (\r
  IN EFI_TREE_PROTOCOL    *This,\r
  IN UINT64               Flags,\r
  IN EFI_PHYSICAL_ADDRESS DataToHash,\r
  IN UINT64               DataToHashLen,\r
  IN TrEE_EVENT           *Event\r
  );\r
\r
/**\r
  This service enables the sending of commands to the TrEE.\r
\r
  @param[in]  This                     Indicates the calling context\r
  @param[in]  InputParameterBlockSize  Size of the TrEE input parameter block.\r
  @param[in]  InputParameterBlock      Pointer to the TrEE input parameter block.\r
  @param[in]  OutputParameterBlockSize Size of the TrEE output parameter block.\r
  @param[in]  OutputParameterBlock     Pointer to the TrEE output parameter block.\r
\r
  @retval EFI_SUCCESS            The command byte stream was successfully sent to the device and a response was successfully received.\r
  @retval EFI_DEVICE_ERROR       The command was not successfully sent to the device or a response was not successfully received from the device.\r
  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
  @retval EFI_BUFFER_TOO_SMALL   The output parameter block is too small. \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TREE_SUBMIT_COMMAND) (\r
  IN EFI_TREE_PROTOCOL *This,\r
  IN UINT32            InputParameterBlockSize,\r
  IN UINT8             *InputParameterBlock,\r
  IN UINT32            OutputParameterBlockSize,\r
  IN UINT8             *OutputParameterBlock\r
  );\r
\r
struct _EFI_TREE_PROTOCOL {\r
  EFI_TREE_GET_CAPABILITY        GetCapability;\r
  EFI_TREE_GET_EVENT_LOG         GetEventLog;\r
  EFI_TREE_HASH_LOG_EXTEND_EVENT HashLogExtendEvent;\r
  EFI_TREE_SUBMIT_COMMAND        SubmitCommand;\r
};\r
\r
extern EFI_GUID gEfiTrEEProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
2e61fb38 JY	1	/** @file\r
	2	Ihis protocol is defined to abstract TPM2 hardware access in boot phase.\r
	3	\r
59b226d6	4	Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>\r
2e61fb38 JY	5	This program and the accompanying materials \r
	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 __TREE_H__\r
	16	#define __TREE_H__\r
	17	\r
	18	#include <IndustryStandard/UefiTcgPlatform.h>\r
	19	#include <IndustryStandard/Tpm20.h>\r
	20	\r
	21	#define EFI_TREE_PROTOCOL_GUID \\r
	22	{0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f}\r
	23	\r
	24	typedef struct _EFI_TREE_PROTOCOL EFI_TREE_PROTOCOL;\r
	25	\r
	26	typedef struct _TREE_VERSION {\r
	27	UINT8 Major;\r
	28	UINT8 Minor;\r
	29	} TREE_VERSION;\r
	30	\r
	31	typedef UINT32 TREE_EVENT_LOG_BITMAP;\r
	32	typedef UINT32 TREE_EVENT_LOG_FORMAT;\r
	33	\r
	34	#define TREE_EVENT_LOG_FORMAT_TCG_1_2 0x00000001\r
	35	\r
	36	typedef struct _TREE_BOOT_SERVICE_CAPABILITY {\r
	37	//\r
	38	// Allocated size of the structure passed in \r
	39	//\r
	40	UINT8 Size;\r
	41	//\r
	42	// Version of the TREE_BOOT_SERVICE_CAPABILITY structure itself.\r
	43	// For this version of the protocol, the Major version shall be set to 1\r
	44	// and the Minor version shall be set to 0. \r
	45	//\r
	46	TREE_VERSION StructureVersion;\r
	47	//\r
	48	// Version of the TrEE protocol.\r
	49	// For this version of the protocol, the Major version shall be set to 1\r
	50	// and the Minor version shall be set to 0. \r
	51	//\r
	52	TREE_VERSION ProtocolVersion;\r
	53	//\r
	54	// Supported hash algorithms\r
	55	//\r
	56	UINT32 HashAlgorithmBitmap;\r
	57	//\r
	58	// Bitmap of supported event log formats\r
	59	//\r
	60	TREE_EVENT_LOG_BITMAP SupportedEventLogs;\r
	61	//\r
	62	// False = TrEE not present \r
	63	//\r
	64	BOOLEAN TrEEPresentFlag;\r
	65	//\r
	66	// Max size (in bytes) of a command that can be sent to the TrEE \r
	67	//\r
	68	UINT16 MaxCommandSize;\r
69	//\r
70	// Max size (in bytes) of a response that can be provided by the TrEE \r
71	//\r
72	UINT16 MaxResponseSize;\r
73	//\r
74	// 4-byte Vendor ID (see Trusted Computing Group, "TCG Vendor ID Registry,"\r
75	// Version 1.0, Revision 0.1, August 31, 2007, "TPM Capabilities Vendor ID" section) \r
76	//\r
77	UINT32 ManufacturerID;\r
78	} TREE_BOOT_SERVICE_CAPABILITY_1_0;\r
79	\r
80	typedef TREE_BOOT_SERVICE_CAPABILITY_1_0 TREE_BOOT_SERVICE_CAPABILITY;\r
81	\r
82	#define TREE_BOOT_HASH_ALG_SHA1 0x00000001\r
83	#define TREE_BOOT_HASH_ALG_SHA256 0x00000002\r
84	#define TREE_BOOT_HASH_ALG_SHA384 0x00000004\r
85	#define TREE_BOOT_HASH_ALG_SHA512 0x00000008\r
86	\r
87	//\r
88	// This bit is shall be set when an event shall be extended but not logged.\r
89	//\r
90	#define TREE_EXTEND_ONLY 0x0000000000000001\r
91	//\r
92	// This bit shall be set when the intent is to measure a PE/COFF image.\r
93	//\r
94	#define PE_COFF_IMAGE 0x0000000000000010\r
95	\r
2e61fb38 JY	96	typedef UINT32 TrEE_PCRINDEX;\r
	97	typedef UINT32 TrEE_EVENTTYPE;\r
	98	\r
	99	#define MAX_PCR_INDEX 23\r
	100	#define TREE_EVENT_HEADER_VERSION 1\r
	101	\r
	102	#pragma pack(1)\r
	103	\r
	104	typedef struct {\r
	105	//\r
	106	// Size of the event header itself (sizeof(TrEE_EVENT_HEADER)). \r
	107	//\r
	108	UINT32 HeaderSize;\r
	109	//\r
	110	// Header version. For this version of this specification, the value shall be 1.\r
	111	//\r
	112	UINT16 HeaderVersion;\r
	113	//\r
	114	// Index of the PCR that shall be extended (0 - 23). \r
	115	//\r
	116	TrEE_PCRINDEX PCRIndex;\r
	117	//\r
	118	// Type of the event that shall be extended (and optionally logged). \r
	119	//\r
	120	TrEE_EVENTTYPE EventType;\r
	121	} TrEE_EVENT_HEADER;\r
	122	\r
	123	typedef struct {\r
	124	//\r
	125	// Total size of the event including the Size component, the header and the Event data. \r
	126	//\r
	127	UINT32 Size;\r
	128	TrEE_EVENT_HEADER Header;\r
	129	UINT8 Event[1];\r
	130	} TrEE_EVENT;\r
	131	\r
	132	#pragma pack()\r
	133	\r
	134	/**\r
	135	The EFI_TREE_PROTOCOL GetCapability function call provides protocol\r
	136	capability information and state information about the TrEE.\r
	137	\r
	138	@param[in] This Indicates the calling context\r
	139	@param[out] ProtocolCapability The caller allocates memory for a TREE_BOOT_SERVICE_CAPABILITY\r
	140	structure and sets the size field to the size of the structure allocated.\r
	141	The callee fills in the fields with the EFI protocol capability information\r
	142	and the current TrEE state information up to the number of fields which\r
	143	fit within the size of the structure passed in.\r
	144	\r
	145	@retval EFI_SUCCESS Operation completed successfully.\r
	146	@retval EFI_DEVICE_ERROR The command was unsuccessful.\r
	147	The ProtocolCapability variable will not be populated. \r
	148	@retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.\r
	149	The ProtocolCapability variable will not be populated.\r
	150	@retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too small to hold the full response.\r
	151	It will be partially populated (required Size field will be set). \r
	152	**/\r
	153	typedef\r
	154	EFI_STATUS\r
	155	(EFIAPI *EFI_TREE_GET_CAPABILITY) (\r
	156	IN EFI_TREE_PROTOCOL *This,\r
	157	IN OUT TREE_BOOT_SERVICE_CAPABILITY *ProtocolCapability\r
	158	);\r
	159	\r
160	/**\r
161	The EFI_TREE_PROTOCOL Get Event Log function call allows a caller to\r
162	retrieve the address of a given event log and its last entry. \r
163	\r
164	@param[in] This Indicates the calling context\r
165	@param[in] EventLogFormat The type of the event log for which the information is requested.\r
166	@param[out] EventLogLocation A pointer to the memory address of the event log.\r
167	@param[out] EventLogLastEntry If the Event Log contains more than one entry, this is a pointer to the\r
168	address of the start of the last entry in the event log in memory.\r
169	@param[out] EventLogTruncated If the Event Log is missing at least one entry because an event would\r
170	have exceeded the area allocated for events, this value is set to TRUE.\r
171	Otherwise, the value will be FALSE and the Event Log will be complete.\r
172	\r
173	@retval EFI_SUCCESS Operation completed successfully.\r
174	@retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect\r
175	(e.g. asking for an event log whose format is not supported).\r
176	**/\r
177	typedef\r
178	EFI_STATUS\r
179	(EFIAPI *EFI_TREE_GET_EVENT_LOG) (\r
180	IN EFI_TREE_PROTOCOL *This,\r
181	IN TREE_EVENT_LOG_FORMAT EventLogFormat,\r
182	OUT EFI_PHYSICAL_ADDRESS *EventLogLocation,\r
183	OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry,\r
184	OUT BOOLEAN *EventLogTruncated\r
185	);\r
186	\r
187	/**\r
188	The EFI_TREE_PROTOCOL HashLogExtendEvent function call provides callers with\r
189	an opportunity to extend and optionally log events without requiring\r
190	knowledge of actual TPM commands. \r
191	The extend operation will occur even if this function cannot create an event\r
192	log entry (e.g. due to the event log being full). \r
193	\r
194	@param[in] This Indicates the calling context\r
195	@param[in] Flags Bitmap providing additional information.\r
196	@param[in] DataToHash Physical address of the start of the data buffer to be hashed. \r
197	@param[in] DataToHashLen The length in bytes of the buffer referenced by DataToHash.\r
198	@param[in] Event Pointer to data buffer containing information about the event.\r
199	\r
200	@retval EFI_SUCCESS Operation completed successfully.\r
201	@retval EFI_DEVICE_ERROR The command was unsuccessful.\r
202	@retval EFI_VOLUME_FULL The extend operation occurred, but the event could not be written to one or more event logs.\r
203	@retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.\r
204	@retval EFI_UNSUPPORTED The PE/COFF image type is not supported.\r
205	**/\r
206	typedef\r
207	EFI_STATUS\r
208	(EFIAPI * EFI_TREE_HASH_LOG_EXTEND_EVENT) (\r
209	IN EFI_TREE_PROTOCOL *This,\r
210	IN UINT64 Flags,\r
211	IN EFI_PHYSICAL_ADDRESS DataToHash,\r
212	IN UINT64 DataToHashLen,\r
213	IN TrEE_EVENT *Event\r
214	);\r
215	\r
216	/**\r
217	This service enables the sending of commands to the TrEE.\r
218	\r
219	@param[in] This Indicates the calling context\r
220	@param[in] InputParameterBlockSize Size of the TrEE input parameter block.\r
221	@param[in] InputParameterBlock Pointer to the TrEE input parameter block.\r
222	@param[in] OutputParameterBlockSize Size of the TrEE output parameter block.\r
223	@param[in] OutputParameterBlock Pointer to the TrEE output parameter block.\r
224	\r
225	@retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.\r
226	@retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.\r
227	@retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.\r
228	@retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. \r
229	**/\r
230	typedef\r
231	EFI_STATUS\r
232	(EFIAPI *EFI_TREE_SUBMIT_COMMAND) (\r
233	IN EFI_TREE_PROTOCOL *This,\r
234	IN UINT32 InputParameterBlockSize,\r
235	IN UINT8 *InputParameterBlock,\r
236	IN UINT32 OutputParameterBlockSize,\r
237	IN UINT8 *OutputParameterBlock\r
238	);\r
239	\r
240	struct _EFI_TREE_PROTOCOL {\r
241	EFI_TREE_GET_CAPABILITY GetCapability;\r
242	EFI_TREE_GET_EVENT_LOG GetEventLog;\r
243	EFI_TREE_HASH_LOG_EXTEND_EVENT HashLogExtendEvent;\r
244	EFI_TREE_SUBMIT_COMMAND SubmitCommand;\r
245	};\r
246	\r
247	extern EFI_GUID gEfiTrEEProtocolGuid;\r
248	\r
249	#endif\r