-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. 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
-Module Name:\r
-\r
- TcgService.h\r
-\r
-Abstract:\r
-\r
- TCG Service Protocol as defined in TCG_EFI_Protocol_1_20_Final\r
-\r
+/** @file\r
+ TCG Service Protocol as defined in TCG_EFI_Protocol_1_22_Final\r
See http://trustedcomputinggroup.org for the latest specification\r
\r
---*/\r
+Copyright (c) 2007 - 2014, 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 <Uefi/UefiTcgPlatform.h>\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
-//\r
-// Set structure alignment to 1-byte\r
-//\r
-#pragma pack (push, 1)\r
-\r
typedef struct {\r
UINT8 Major;\r
UINT8 Minor;\r
} TCG_VERSION;\r
\r
typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {\r
- UINT8 Size; // Size of this structure\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
+ 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
-// Restore original structure alignment\r
-//\r
-#pragma pack (pop)\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
+(EFIAPI *EFI_TCG_STATUS_CHECK)(\r
IN EFI_TCG_PROTOCOL *This,\r
OUT TCG_EFI_BOOT_SERVICE_CAPABILITY\r
*ProtocolCapability,\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
+(EFIAPI *EFI_TCG_HASH_ALL)(\r
IN EFI_TCG_PROTOCOL *This,\r
IN UINT8 *HashData,\r
IN UINT64 HashDataLen,\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
+(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
+(EFIAPI *EFI_TCG_PASS_THROUGH_TO_TPM)(\r
IN EFI_TCG_PROTOCOL *This,\r
- IN UINT32 TpmInputParamterBlockSize,\r
- IN UINT8 *TpmInputParamterBlock,\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
+(EFIAPI *EFI_TCG_HASH_LOG_EXTEND_EVENT)(\r
IN EFI_TCG_PROTOCOL *This,\r
- IN UINT8 *HashData,\r
+ IN EFI_PHYSICAL_ADDRESS HashData,\r
IN UINT64 HashDataLen,\r
IN TCG_ALGORITHM_ID AlgorithmId,\r
IN OUT TCG_PCR_EVENT *TCGLogData,\r
OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry\r
);\r
\r
-typedef struct _EFI_TCG_PROTOCOL {\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
-} EFI_TCG_PROTOCOL;\r
+};\r
\r
extern EFI_GUID gEfiTcgProtocolGuid;\r
\r
projects / mirror_edk2.git / blobdiff