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

/** @file\r
  TCG Service Protocol as defined in TCG_EFI_Protocol_1_20_Final\r
  See http://trustedcomputinggroup.org for the latest specification\r
\r
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
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 _TCG_SERVICE_PROTOCOL_H_\r
#define _TCG_SERVICE_PROTOCOL_H_\r
\r
#include <IndustryStandard/UefiTcgPlatform.h>\r
\r
#define EFI_TCG_PROTOCOL_GUID  \\r
  {0xf541796d, 0xa62e, 0x4954, { 0xa7, 0x75, 0x95, 0x84, 0xf6, 0x1b, 0x9c, 0xdd } } \r
\r
typedef struct _EFI_TCG_PROTOCOL EFI_TCG_PROTOCOL;\r
\r
typedef struct {\r
  UINT8  Major;\r
  UINT8  Minor;\r
  UINT8  RevMajor;\r
  UINT8  RevMinor;\r
} TCG_VERSION;\r
\r
typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {\r
  UINT8          Size;                /// Size of this structure.\r
  TCG_VERSION    StructureVersion;    \r
  TCG_VERSION    ProtocolSpecVersion;\r
  UINT8          HashAlgorithmBitmap; /// Hash algorithms . \r
                                      /// This protocol is capable of : 01=SHA-1.\r
  BOOLEAN        TPMPresentFlag;      /// 00h = TPM not present.\r
  BOOLEAN        TPMDeactivatedFlag;  /// 01h = TPM currently deactivated.\r
} TCG_EFI_BOOT_SERVICE_CAPABILITY;\r
\r
typedef UINT32   TCG_ALGORITHM_ID;\r
\r
///\r
/// Note:\r
///   Status codes returned for functions of EFI_TCG_PROTOCOL do not exactly match\r
///   those defined in the TCG EFI Protocol 1.20 Final Specification.\r
///\r
\r
/**\r
  This service provides EFI protocol capability information, state information \r
  about the TPM, and Event Log state information.\r
\r
  @param  This                   Indicates the calling context\r
  @param  ProtocolCapability     The callee allocates memory for a TCG_BOOT_SERVICE_CAPABILITY \r
                                 structure and fills in the fields with the EFI protocol \r
                                 capability information and the current TPM state information.\r
  @param  TCGFeatureFlags        This is a pointer to the feature flags. No feature \r
                                 flags are currently defined so this parameter \r
                                 MUST be set to 0. However, in the future, \r
                                 feature flags may be defined that, for example, \r
                                 enable hash algorithm agility.\r
  @param  EventLogLocation       This is a pointer to the address of the event log in memory.\r
  @param  EventLogLastEntry      If the Event Log contains more than one entry, \r
                                 this is a pointer to the address of the start of \r
                                 the last entry in the event log in memory. \r
\r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER  ProtocolCapability does not match TCG capability.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCG_STATUS_CHECK)(\r
  IN      EFI_TCG_PROTOCOL          *This,\r
  OUT     TCG_EFI_BOOT_SERVICE_CAPABILITY\r
                                    *ProtocolCapability,\r
  OUT     UINT32                    *TCGFeatureFlags,\r
  OUT     EFI_PHYSICAL_ADDRESS      *EventLogLocation,\r
  OUT     EFI_PHYSICAL_ADDRESS      *EventLogLastEntry\r
  );\r
\r
/**\r
  This service abstracts the capability to do a hash operation on a data buffer.\r
  \r
  @param  This                   Indicates the calling context.\r
  @param  HashData               The pointer to the data buffer to be hashed.\r
  @param  HashDataLen            The length of the data buffer to be hashed.\r
  @param  AlgorithmId            Identification of the Algorithm to use for the hashing operation.\r
  @param  HashedDataLen          Resultant length of the hashed data.\r
  @param  HashedDataResult       Resultant buffer of the hashed data.\r
  \r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER  HashDataLen is NULL.\r
  @retval EFI_INVALID_PARAMETER  HashDataLenResult is NULL.\r
  @retval EFI_OUT_OF_RESOURCES   Cannot allocate buffer of size *HashedDataLen.\r
  @retval EFI_UNSUPPORTED        AlgorithmId not supported.\r
  @retval EFI_BUFFER_TOO_SMALL   *HashedDataLen < sizeof (TCG_DIGEST).\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCG_HASH_ALL)(\r
  IN      EFI_TCG_PROTOCOL          *This,\r
  IN      UINT8                     *HashData,\r
  IN      UINT64                    HashDataLen,\r
  IN      TCG_ALGORITHM_ID          AlgorithmId,\r
  IN OUT  UINT64                    *HashedDataLen,\r
  IN OUT  UINT8                     **HashedDataResult\r
  );\r
\r
/**\r
  This service abstracts the capability to add an entry to the Event Log.\r
\r
  @param  This                   Indicates the calling context\r
  @param  TCGLogData             The pointer to the start of the data buffer containing \r
                                 the TCG_PCR_EVENT data structure. All fields in \r
                                 this structure are properly filled by the caller.\r
  @param  EventNumber            The event number of the event just logged.\r
  @param  Flags                  Indicates additional flags. Only one flag has been \r
                                 defined at this time, which is 0x01 and means the \r
                                 extend operation should not be performed. All \r
                                 other bits are reserved. \r
 \r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_OUT_OF_RESOURCES   Insufficient memory in the event log to complete this action.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCG_LOG_EVENT)(\r
  IN      EFI_TCG_PROTOCOL          *This,\r
  IN      TCG_PCR_EVENT             *TCGLogData,\r
  IN OUT  UINT32                    *EventNumber,\r
  IN      UINT32                    Flags\r
  );\r
\r
/**\r
  This service is a proxy for commands to the TPM.\r
\r
  @param  This                        Indicates the calling context.\r
  @param  TpmInputParameterBlockSize  Size of the TPM input parameter block.\r
  @param  TpmInputParameterBlock      The pointer to the TPM input parameter block.\r
  @param  TpmOutputParameterBlockSize Size of the TPM output parameter block.\r
  @param  TpmOutputParameterBlock     The pointer to the TPM output parameter block.\r
\r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER  Invalid ordinal.\r
  @retval EFI_UNSUPPORTED        Current Task Priority Level  >= EFI_TPL_CALLBACK.\r
  @retval EFI_TIMEOUT            The TIS timed-out.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCG_PASS_THROUGH_TO_TPM)(\r
  IN      EFI_TCG_PROTOCOL          *This,\r
  IN      UINT32                    TpmInputParameterBlockSize,\r
  IN      UINT8                     *TpmInputParameterBlock,\r
  IN      UINT32                    TpmOutputParameterBlockSize,\r
  IN      UINT8                     *TpmOutputParameterBlock\r
  );\r
\r
/**\r
  This service abstracts the capability to do a hash operation on a data buffer, extend a specific TPM PCR with the hash result, and add an entry to the Event Log\r
\r
  @param  This                   Indicates the calling context\r
  @param  HashData               The physical address of the start of the data buffer \r
                                 to be hashed, extended, and logged.\r
  @param  HashDataLen            The length, in bytes, of the buffer referenced by HashData\r
  @param  AlgorithmId            Identification of the Algorithm to use for the hashing operation\r
  @param  TCGLogData             The physical address of the start of the data \r
                                 buffer containing the TCG_PCR_EVENT data structure.\r
  @param  EventNumber            The event number of the event just logged.\r
  @param  EventLogLastEntry      The physical address of the first byte of the entry \r
                                 just placed in the Event Log. If the Event Log was \r
                                 empty when this function was called then this physical \r
                                 address will be the same as the physical address of \r
                                 the start of the Event Log.\r
\r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_UNSUPPORTED        AlgorithmId != TPM_ALG_SHA.\r
  @retval EFI_UNSUPPORTED        Current TPL >= EFI_TPL_CALLBACK.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCG_HASH_LOG_EXTEND_EVENT)(\r
  IN      EFI_TCG_PROTOCOL          *This,\r
  IN      EFI_PHYSICAL_ADDRESS      HashData,\r
  IN      UINT64                    HashDataLen,\r
  IN      TCG_ALGORITHM_ID          AlgorithmId,\r
  IN OUT  TCG_PCR_EVENT             *TCGLogData,\r
  IN OUT  UINT32                    *EventNumber,\r
     OUT  EFI_PHYSICAL_ADDRESS      *EventLogLastEntry\r
  );\r
\r
///\r
/// The EFI_TCG Protocol abstracts TCG activity.\r
///\r
struct _EFI_TCG_PROTOCOL {\r
  EFI_TCG_STATUS_CHECK              StatusCheck;\r
  EFI_TCG_HASH_ALL                  HashAll;\r
  EFI_TCG_LOG_EVENT                 LogEvent;\r
  EFI_TCG_PASS_THROUGH_TO_TPM       PassThroughToTpm;\r
  EFI_TCG_HASH_LOG_EXTEND_EVENT     HashLogExtendEvent;\r
};\r
\r
extern EFI_GUID gEfiTcgProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	TCG Service Protocol as defined in TCG_EFI_Protocol_1_20_Final\r
	3	See http://trustedcomputinggroup.org for the latest specification\r
	4	\r
	5	Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials are licensed and made available under \r
	7	the terms and conditions of the BSD License that accompanies this distribution. \r
	8	The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php. \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef _TCG_SERVICE_PROTOCOL_H_\r
	17	#define _TCG_SERVICE_PROTOCOL_H_\r
	18	\r
	19	#include <IndustryStandard/UefiTcgPlatform.h>\r
	20	\r
	21	#define EFI_TCG_PROTOCOL_GUID \\r
	22	{0xf541796d, 0xa62e, 0x4954, { 0xa7, 0x75, 0x95, 0x84, 0xf6, 0x1b, 0x9c, 0xdd } } \r
	23	\r
	24	typedef struct _EFI_TCG_PROTOCOL EFI_TCG_PROTOCOL;\r
	25	\r
	26	typedef struct {\r
	27	UINT8 Major;\r
	28	UINT8 Minor;\r
	29	UINT8 RevMajor;\r
	30	UINT8 RevMinor;\r
	31	} TCG_VERSION;\r
	32	\r
	33	typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {\r
	34	UINT8 Size; /// Size of this structure.\r
	35	TCG_VERSION StructureVersion; \r
	36	TCG_VERSION ProtocolSpecVersion;\r
	37	UINT8 HashAlgorithmBitmap; /// Hash algorithms . \r
	38	/// This protocol is capable of : 01=SHA-1.\r
	39	BOOLEAN TPMPresentFlag; /// 00h = TPM not present.\r
	40	BOOLEAN TPMDeactivatedFlag; /// 01h = TPM currently deactivated.\r
	41	} TCG_EFI_BOOT_SERVICE_CAPABILITY;\r
	42	\r
	43	typedef UINT32 TCG_ALGORITHM_ID;\r
	44	\r
	45	///\r
	46	/// Note:\r
	47	/// Status codes returned for functions of EFI_TCG_PROTOCOL do not exactly match\r
	48	/// those defined in the TCG EFI Protocol 1.20 Final Specification.\r
	49	///\r
	50	\r
	51	/**\r
	52	This service provides EFI protocol capability information, state information \r
	53	about the TPM, and Event Log state information.\r
	54	\r
	55	@param This Indicates the calling context\r
	56	@param ProtocolCapability The callee allocates memory for a TCG_BOOT_SERVICE_CAPABILITY \r
	57	structure and fills in the fields with the EFI protocol \r
	58	capability information and the current TPM state information.\r
	59	@param TCGFeatureFlags This is a pointer to the feature flags. No feature \r
	60	flags are currently defined so this parameter \r
	61	MUST be set to 0. However, in the future, \r
	62	feature flags may be defined that, for example, \r
	63	enable hash algorithm agility.\r
	64	@param EventLogLocation This is a pointer to the address of the event log in memory.\r
	65	@param EventLogLastEntry If the Event Log contains more than one entry, \r
	66	this is a pointer to the address of the start of \r
	67	the last entry in the event log in memory. \r
	68	\r
	69	@retval EFI_SUCCESS The operation completed successfully.\r
	70	@retval EFI_INVALID_PARAMETER ProtocolCapability does not match TCG capability.\r
	71	**/\r
	72	typedef\r
	73	EFI_STATUS\r
	74	(EFIAPI *EFI_TCG_STATUS_CHECK)(\r
	75	IN EFI_TCG_PROTOCOL *This,\r
	76	OUT TCG_EFI_BOOT_SERVICE_CAPABILITY\r
	77	*ProtocolCapability,\r
	78	OUT UINT32 *TCGFeatureFlags,\r
	79	OUT EFI_PHYSICAL_ADDRESS *EventLogLocation,\r
	80	OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry\r
	81	);\r
	82	\r
	83	/**\r
	84	This service abstracts the capability to do a hash operation on a data buffer.\r
	85	\r
	86	@param This Indicates the calling context.\r
	87	@param HashData The pointer to the data buffer to be hashed.\r
	88	@param HashDataLen The length of the data buffer to be hashed.\r
	89	@param AlgorithmId Identification of the Algorithm to use for the hashing operation.\r
	90	@param HashedDataLen Resultant length of the hashed data.\r
	91	@param HashedDataResult Resultant buffer of the hashed data.\r
	92	\r
	93	@retval EFI_SUCCESS The operation completed successfully.\r
	94	@retval EFI_INVALID_PARAMETER HashDataLen is NULL.\r
	95	@retval EFI_INVALID_PARAMETER HashDataLenResult is NULL.\r
	96	@retval EFI_OUT_OF_RESOURCES Cannot allocate buffer of size *HashedDataLen.\r
	97	@retval EFI_UNSUPPORTED AlgorithmId not supported.\r
	98	@retval EFI_BUFFER_TOO_SMALL *HashedDataLen < sizeof (TCG_DIGEST).\r
	99	**/\r
	100	typedef\r
	101	EFI_STATUS\r
	102	(EFIAPI *EFI_TCG_HASH_ALL)(\r
	103	IN EFI_TCG_PROTOCOL *This,\r
	104	IN UINT8 *HashData,\r
	105	IN UINT64 HashDataLen,\r
	106	IN TCG_ALGORITHM_ID AlgorithmId,\r
	107	IN OUT UINT64 *HashedDataLen,\r
	108	IN OUT UINT8 **HashedDataResult\r
	109	);\r
	110	\r
	111	/**\r
	112	This service abstracts the capability to add an entry to the Event Log.\r
	113	\r
	114	@param This Indicates the calling context\r
	115	@param TCGLogData The pointer to the start of the data buffer containing \r
	116	the TCG_PCR_EVENT data structure. All fields in \r
	117	this structure are properly filled by the caller.\r
	118	@param EventNumber The event number of the event just logged.\r
	119	@param Flags Indicates additional flags. Only one flag has been \r
	120	defined at this time, which is 0x01 and means the \r
	121	extend operation should not be performed. All \r
	122	other bits are reserved. \r
	123	\r
	124	@retval EFI_SUCCESS The operation completed successfully.\r
	125	@retval EFI_OUT_OF_RESOURCES Insufficient memory in the event log to complete this action.\r
	126	**/\r
	127	typedef\r
	128	EFI_STATUS\r
	129	(EFIAPI *EFI_TCG_LOG_EVENT)(\r
	130	IN EFI_TCG_PROTOCOL *This,\r
	131	IN TCG_PCR_EVENT *TCGLogData,\r
	132	IN OUT UINT32 *EventNumber,\r
	133	IN UINT32 Flags\r
	134	);\r
	135	\r
	136	/**\r
	137	This service is a proxy for commands to the TPM.\r
	138	\r
	139	@param This Indicates the calling context.\r
	140	@param TpmInputParameterBlockSize Size of the TPM input parameter block.\r
	141	@param TpmInputParameterBlock The pointer to the TPM input parameter block.\r
	142	@param TpmOutputParameterBlockSize Size of the TPM output parameter block.\r
	143	@param TpmOutputParameterBlock The pointer to the TPM output parameter block.\r
	144	\r
	145	@retval EFI_SUCCESS The operation completed successfully.\r
	146	@retval EFI_INVALID_PARAMETER Invalid ordinal.\r
	147	@retval EFI_UNSUPPORTED Current Task Priority Level >= EFI_TPL_CALLBACK.\r
	148	@retval EFI_TIMEOUT The TIS timed-out.\r
	149	**/\r
	150	typedef\r
	151	EFI_STATUS\r
	152	(EFIAPI *EFI_TCG_PASS_THROUGH_TO_TPM)(\r
	153	IN EFI_TCG_PROTOCOL *This,\r
	154	IN UINT32 TpmInputParameterBlockSize,\r
	155	IN UINT8 *TpmInputParameterBlock,\r
	156	IN UINT32 TpmOutputParameterBlockSize,\r
	157	IN UINT8 *TpmOutputParameterBlock\r
	158	);\r
	159	\r
	160	/**\r
	161	This service abstracts the capability to do a hash operation on a data buffer, extend a specific TPM PCR with the hash result, and add an entry to the Event Log\r
	162	\r
	163	@param This Indicates the calling context\r
	164	@param HashData The physical address of the start of the data buffer \r
	165	to be hashed, extended, and logged.\r
	166	@param HashDataLen The length, in bytes, of the buffer referenced by HashData\r
	167	@param AlgorithmId Identification of the Algorithm to use for the hashing operation\r
	168	@param TCGLogData The physical address of the start of the data \r
	169	buffer containing the TCG_PCR_EVENT data structure.\r
	170	@param EventNumber The event number of the event just logged.\r
	171	@param EventLogLastEntry The physical address of the first byte of the entry \r
	172	just placed in the Event Log. If the Event Log was \r
	173	empty when this function was called then this physical \r
	174	address will be the same as the physical address of \r
	175	the start of the Event Log.\r
	176	\r
	177	@retval EFI_SUCCESS The operation completed successfully.\r
	178	@retval EFI_UNSUPPORTED AlgorithmId != TPM_ALG_SHA.\r
	179	@retval EFI_UNSUPPORTED Current TPL >= EFI_TPL_CALLBACK.\r
	180	@retval EFI_DEVICE_ERROR The command was unsuccessful.\r
	181	**/\r
	182	typedef\r
	183	EFI_STATUS\r
	184	(EFIAPI *EFI_TCG_HASH_LOG_EXTEND_EVENT)(\r
	185	IN EFI_TCG_PROTOCOL *This,\r
	186	IN EFI_PHYSICAL_ADDRESS HashData,\r
	187	IN UINT64 HashDataLen,\r
	188	IN TCG_ALGORITHM_ID AlgorithmId,\r
	189	IN OUT TCG_PCR_EVENT *TCGLogData,\r
	190	IN OUT UINT32 *EventNumber,\r
	191	OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry\r
	192	);\r
	193	\r
	194	///\r
	195	/// The EFI_TCG Protocol abstracts TCG activity.\r
	196	///\r
	197	struct _EFI_TCG_PROTOCOL {\r
	198	EFI_TCG_STATUS_CHECK StatusCheck;\r
	199	EFI_TCG_HASH_ALL HashAll;\r
	200	EFI_TCG_LOG_EVENT LogEvent;\r
	201	EFI_TCG_PASS_THROUGH_TO_TPM PassThroughToTpm;\r
	202	EFI_TCG_HASH_LOG_EXTEND_EVENT HashLogExtendEvent;\r
	203	};\r
	204	\r
	205	extern EFI_GUID gEfiTcgProtocolGuid;\r
	206	\r
	207	#endif\r