iPXE
Data Structures | Macros | Typedefs | Functions | Variables
TcgService.h File Reference

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

#include <ipxe/efi/IndustryStandard/UefiTcgPlatform.h>

Go to the source code of this file.

Data Structures

struct  TCG_VERSION
 
struct  _TCG_EFI_BOOT_SERVICE_CAPABILITY
 
struct  _EFI_TCG_PROTOCOL
 The EFI_TCG Protocol abstracts TCG activity. More...
 

Macros

#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(EFIAPIEFI_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)
 This service provides EFI protocol capability information, state information about the TPM, and Event Log state information. More...
 
typedef EFI_STATUS(EFIAPIEFI_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. More...
 
typedef EFI_STATUS(EFIAPIEFI_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. More...
 
typedef EFI_STATUS(EFIAPIEFI_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. More...
 
typedef EFI_STATUS(EFIAPIEFI_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. More...
 

Functions

 FILE_LICENCE (BSD2_PATENT)
 

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 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file TcgService.h.

Macro Definition Documentation

◆ EFI_TCG_PROTOCOL_GUID

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

Definition at line 17 of file TcgService.h.

Typedef Documentation

◆ EFI_TCG_PROTOCOL

Definition at line 20 of file TcgService.h.

◆ TCG_EFI_BOOT_SERVICE_CAPABILITY

◆ TCG_ALGORITHM_ID

Definition at line 39 of file TcgService.h.

◆ EFI_TCG_STATUS_CHECK

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)

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

Parameters
ThisIndicates the calling context
ProtocolCapabilityThe 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.
TCGFeatureFlagsThis 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.
EventLogLocationThis is a pointer to the address of the event log in memory.
EventLogLastEntryIf 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_SUCCESSThe operation completed successfully.
EFI_INVALID_PARAMETERProtocolCapability does not match TCG capability.

Definition at line 64 of file TcgService.h.

◆ EFI_TCG_HASH_ALL

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
ThisIndicates the calling context.
HashDataThe pointer to the data buffer to be hashed.
HashDataLenThe length of the data buffer to be hashed.
AlgorithmIdIdentification of the Algorithm to use for the hashing operation.
HashedDataLenResultant length of the hashed data.
HashedDataResultResultant buffer of the hashed data.
Return values
EFI_SUCCESSThe operation completed successfully.
EFI_INVALID_PARAMETERHashDataLen is NULL.
EFI_INVALID_PARAMETERHashDataLenResult is NULL.
EFI_OUT_OF_RESOURCESCannot allocate buffer of size *HashedDataLen.
EFI_UNSUPPORTEDAlgorithmId not supported.
EFI_BUFFER_TOO_SMALL*HashedDataLen < sizeof (TCG_DIGEST).

Definition at line 92 of file TcgService.h.

◆ EFI_TCG_LOG_EVENT

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
ThisIndicates the calling context
TCGLogDataThe 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.
EventNumberThe event number of the event just logged.
FlagsIndicates 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_SUCCESSThe operation completed successfully.
EFI_OUT_OF_RESOURCESInsufficient memory in the event log to complete this action.

Definition at line 119 of file TcgService.h.

◆ EFI_TCG_PASS_THROUGH_TO_TPM

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
ThisIndicates the calling context.
TpmInputParameterBlockSizeSize of the TPM input parameter block.
TpmInputParameterBlockThe pointer to the TPM input parameter block.
TpmOutputParameterBlockSizeSize of the TPM output parameter block.
TpmOutputParameterBlockThe pointer to the TPM output parameter block.
Return values
EFI_SUCCESSThe operation completed successfully.
EFI_INVALID_PARAMETERInvalid ordinal.
EFI_UNSUPPORTEDCurrent Task Priority Level >= EFI_TPL_CALLBACK.
EFI_TIMEOUTThe TIS timed-out.

Definition at line 142 of file TcgService.h.

◆ EFI_TCG_HASH_LOG_EXTEND_EVENT

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
ThisIndicates the calling context
HashDataThe physical address of the start of the data buffer to be hashed, extended, and logged.
HashDataLenThe length, in bytes, of the buffer referenced by HashData
AlgorithmIdIdentification of the Algorithm to use for the hashing operation
TCGLogDataThe physical address of the start of the data buffer containing the TCG_PCR_EVENT data structure.
EventNumberThe event number of the event just logged.
EventLogLastEntryThe 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_SUCCESSThe operation completed successfully.
EFI_UNSUPPORTEDAlgorithmId != TPM_ALG_SHA.
EFI_UNSUPPORTEDCurrent TPL >= EFI_TPL_CALLBACK.
EFI_DEVICE_ERRORThe command was unsuccessful.

Definition at line 174 of file TcgService.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT  )

Variable Documentation

◆ gEfiTcgProtocolGuid

EFI_GUID gEfiTcgProtocolGuid