MdePkg/Include/Protocol/TcgService.h File Reference


Data Structures

struct  TCG_VERSION
struct  _TCG_EFI_BOOT_SERVICE_CAPABILITY
struct  _EFI_TCG_PROTOCOL

Defines

#define EFI_TCG_PROTOCOL_GUID   {0xf541796d, 0xa62e, 0x4954, { 0xa7, 0x75, 0x95, 0x84, 0xf6, 0x1b, 0x9c, 0xdd } }

Typedefs

typedef struct _EFI_TCG_PROTOCOL EFI_TCG_PROTOCOL
typedef struct
_TCG_EFI_BOOT_SERVICE_CAPABILITY 
TCG_EFI_BOOT_SERVICE_CAPABILITY
typedef UINT32 TCG_ALGORITHM_ID
typedef EFI_STATUS(EFIAPI * EFI_TCG_STATUS_CHECK )(IN EFI_TCG_PROTOCOL *This, OUT TCG_EFI_BOOT_SERVICE_CAPABILITY *ProtocolCapability, OUT UINT32 *TCGFeatureFlags, OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry)
typedef EFI_STATUS(EFIAPI * EFI_TCG_HASH_ALL )(IN EFI_TCG_PROTOCOL *This, IN UINT8 *HashData, IN UINT64 HashDataLen, IN TCG_ALGORITHM_ID AlgorithmId, IN OUT UINT64 *HashedDataLen, IN OUT UINT8 **HashedDataResult)
typedef EFI_STATUS(EFIAPI * EFI_TCG_LOG_EVENT )(IN EFI_TCG_PROTOCOL *This, IN TCG_PCR_EVENT *TCGLogData, IN OUT UINT32 *EventNumber, IN UINT32 Flags)
typedef EFI_STATUS(EFIAPI * EFI_TCG_PASS_THROUGH_TO_TPM )(IN EFI_TCG_PROTOCOL *This, IN UINT32 TpmInputParameterBlockSize, IN UINT8 *TpmInputParameterBlock, IN UINT32 TpmOutputParameterBlockSize, IN UINT8 *TpmOutputParameterBlock)
typedef EFI_STATUS(EFIAPI * EFI_TCG_HASH_LOG_EXTEND_EVENT )(IN EFI_TCG_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS HashData, IN UINT64 HashDataLen, IN TCG_ALGORITHM_ID AlgorithmId, IN OUT TCG_PCR_EVENT *TCGLogData, IN OUT UINT32 *EventNumber, OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry)

Variables

EFI_GUID gEfiTcgProtocolGuid

Detailed Description

TCG Service Protocol as defined in TCG_EFI_Protocol_1_22_Final See http://trustedcomputinggroup.org for the latest specification

Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define EFI_TCG_PROTOCOL_GUID   {0xf541796d, 0xa62e, 0x4954, { 0xa7, 0x75, 0x95, 0x84, 0xf6, 0x1b, 0x9c, 0xdd } }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_TCG_HASH_ALL)(IN EFI_TCG_PROTOCOL *This, IN UINT8 *HashData, IN UINT64 HashDataLen, IN TCG_ALGORITHM_ID AlgorithmId, IN OUT UINT64 *HashedDataLen, IN OUT UINT8 **HashedDataResult)

This service abstracts the capability to do a hash operation on a data buffer.

Parameters:
This Indicates the calling context.
HashData The pointer to the data buffer to be hashed.
HashDataLen The length of the data buffer to be hashed.
AlgorithmId Identification of the Algorithm to use for the hashing operation.
HashedDataLen Resultant length of the hashed data.
HashedDataResult Resultant buffer of the hashed data.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_INVALID_PARAMETER HashDataLen is NULL.
EFI_INVALID_PARAMETER HashDataLenResult is NULL.
EFI_OUT_OF_RESOURCES Cannot allocate buffer of size *HashedDataLen.
EFI_UNSUPPORTED AlgorithmId not supported.
EFI_BUFFER_TOO_SMALL *HashedDataLen < sizeof (TCG_DIGEST).

typedef EFI_STATUS(EFIAPI * EFI_TCG_HASH_LOG_EXTEND_EVENT)(IN EFI_TCG_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS HashData, IN UINT64 HashDataLen, IN TCG_ALGORITHM_ID AlgorithmId, IN OUT TCG_PCR_EVENT *TCGLogData, IN OUT UINT32 *EventNumber, OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry)

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

Parameters:
This Indicates the calling context
HashData The physical address of the start of the data buffer to be hashed, extended, and logged.
HashDataLen The length, in bytes, of the buffer referenced by HashData
AlgorithmId Identification of the Algorithm to use for the hashing operation
TCGLogData The physical address of the start of the data buffer containing the TCG_PCR_EVENT data structure.
EventNumber The event number of the event just logged.
EventLogLastEntry The physical address of the first byte of the entry just placed in the Event Log. If the Event Log was empty when this function was called then this physical address will be the same as the physical address of the start of the Event Log.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_UNSUPPORTED AlgorithmId != TPM_ALG_SHA.
EFI_UNSUPPORTED Current TPL >= EFI_TPL_CALLBACK.
EFI_DEVICE_ERROR The command was unsuccessful.

typedef EFI_STATUS(EFIAPI * EFI_TCG_LOG_EVENT)(IN EFI_TCG_PROTOCOL *This, IN TCG_PCR_EVENT *TCGLogData, IN OUT UINT32 *EventNumber, IN UINT32 Flags)

This service abstracts the capability to add an entry to the Event Log.

Parameters:
This Indicates the calling context
TCGLogData The pointer to the start of the data buffer containing the TCG_PCR_EVENT data structure. All fields in this structure are properly filled by the caller.
EventNumber The event number of the event just logged.
Flags Indicates additional flags. Only one flag has been defined at this time, which is 0x01 and means the extend operation should not be performed. All other bits are reserved.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_OUT_OF_RESOURCES Insufficient memory in the event log to complete this action.

typedef EFI_STATUS(EFIAPI * EFI_TCG_PASS_THROUGH_TO_TPM)(IN EFI_TCG_PROTOCOL *This, IN UINT32 TpmInputParameterBlockSize, IN UINT8 *TpmInputParameterBlock, IN UINT32 TpmOutputParameterBlockSize, IN UINT8 *TpmOutputParameterBlock)

This service is a proxy for commands to the TPM.

Parameters:
This Indicates the calling context.
TpmInputParameterBlockSize Size of the TPM input parameter block.
TpmInputParameterBlock The pointer to the TPM input parameter block.
TpmOutputParameterBlockSize Size of the TPM output parameter block.
TpmOutputParameterBlock The pointer to the TPM output parameter block.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_INVALID_PARAMETER Invalid ordinal.
EFI_UNSUPPORTED Current Task Priority Level >= EFI_TPL_CALLBACK.
EFI_TIMEOUT The TIS timed-out.

This service provides EFI protocol capability information, state information about the TPM, and Event Log state information.

Parameters:
This Indicates the calling context
ProtocolCapability The callee allocates memory for a TCG_BOOT_SERVICE_CAPABILITY structure and fills in the fields with the EFI protocol capability information and the current TPM state information.
TCGFeatureFlags This is a pointer to the feature flags. No feature flags are currently defined so this parameter MUST be set to 0. However, in the future, feature flags may be defined that, for example, enable hash algorithm agility.
EventLogLocation This is a pointer to the address of the event log in memory.
EventLogLastEntry If the Event Log contains more than one entry, this is a pointer to the address of the start of the last entry in the event log in memory.
Return values:
EFI_SUCCESS The operation completed successfully.
EFI_INVALID_PARAMETER ProtocolCapability does not match TCG capability.


Variable Documentation


Generated on Wed Sep 23 16:24:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1