MdePkg/Include/Protocol/Tcg2Protocol.h File Reference


Data Structures

struct  tdEFI_TCG2_VERSION
struct  tdEFI_TCG2_BOOT_SERVICE_CAPABILITY
struct  EFI_TCG2_EVENT_HEADER
struct  tdEFI_TCG2_EVENT
struct  tdEFI_TCG2_PROTOCOL
struct  tdEFI_TCG2_FINAL_EVENTS_TABLE

Defines

#define EFI_TCG2_PROTOCOL_GUID   {0x607f766c, 0x7455, 0x42be, { 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f }}
#define EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2   0x00000001
#define EFI_TCG2_EVENT_LOG_FORMAT_TCG_2   0x00000002
#define EFI_TCG2_BOOT_HASH_ALG_SHA1   0x00000001
#define EFI_TCG2_BOOT_HASH_ALG_SHA256   0x00000002
#define EFI_TCG2_BOOT_HASH_ALG_SHA384   0x00000004
#define EFI_TCG2_BOOT_HASH_ALG_SHA512   0x00000008
#define EFI_TCG2_BOOT_HASH_ALG_SM3_256   0x00000010
#define EFI_TCG2_EXTEND_ONLY   0x0000000000000001
#define PE_COFF_IMAGE   0x0000000000000010
#define MAX_PCR_INDEX   23
#define EFI_TCG2_EVENT_HEADER_VERSION   1
#define EFI_TCG2_FINAL_EVENTS_TABLE_GUID   {0x1e2ed096, 0x30e2, 0x4254, { 0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25 }}
#define EFI_TCG2_FINAL_EVENTS_TABLE_VERSION   1

Typedefs

typedef struct tdEFI_TCG2_PROTOCOL EFI_TCG2_PROTOCOL
typedef struct tdEFI_TCG2_VERSION EFI_TCG2_VERSION
typedef UINT32 EFI_TCG2_EVENT_LOG_BITMAP
typedef UINT32 EFI_TCG2_EVENT_LOG_FORMAT
typedef UINT32 EFI_TCG2_EVENT_ALGORITHM_BITMAP
typedef struct
tdEFI_TCG2_BOOT_SERVICE_CAPABILITY 
EFI_TCG2_BOOT_SERVICE_CAPABILITY
typedef struct tdEFI_TCG2_EVENT EFI_TCG2_EVENT
typedef IN OUT
EFI_TCG2_BOOT_SERVICE_CAPABILITY
ProtocolCapability
typedef IN
EFI_TCG2_EVENT_LOG_FORMAT 
EventLogFormat
typedef IN
EFI_TCG2_EVENT_LOG_FORMAT OUT
EFI_PHYSICAL_ADDRESS
EventLogLocation
typedef IN
EFI_TCG2_EVENT_LOG_FORMAT OUT
EFI_PHYSICAL_ADDRESS OUT
EFI_PHYSICAL_ADDRESS
EventLogLastEntry
typedef IN
EFI_TCG2_EVENT_LOG_FORMAT OUT
EFI_PHYSICAL_ADDRESS OUT
EFI_PHYSICAL_ADDRESS OUT
BOOLEAN
EventLogTruncated
typedef IN UINT64 Flags
typedef IN UINT64 IN
EFI_PHYSICAL_ADDRESS 
DataToHash
typedef IN UINT64 IN
EFI_PHYSICAL_ADDRESS IN UINT64 
DataToHashLen
typedef IN UINT64 IN
EFI_PHYSICAL_ADDRESS IN UINT64
IN EFI_TCG2_EVENT
EfiTcgEvent
typedef IN UINT32 InputParameterBlockSize
typedef IN UINT32 IN UINT8InputParameterBlock
typedef IN UINT32 IN UINT8 IN
UINT32 
OutputParameterBlockSize
typedef IN UINT32 IN UINT8 IN
UINT32 IN UINT8
OutputParameterBlock
typedef OUT UINT32ActivePcrBanks
typedef OUT UINT32OperationPresent
typedef OUT UINT32 OUT UINT32Response
typedef struct
tdEFI_TCG2_FINAL_EVENTS_TABLE 
EFI_TCG2_FINAL_EVENTS_TABLE

Functions

typedef EFI_STATUS (EFIAPI *EFI_TCG2_GET_CAPABILITY)(IN EFI_TCG2_PROTOCOL *This

Variables

EFI_GUID gEfiTcg2ProtocolGuid
EFI_GUID gEfiTcg2FinalEventsTableGuid

Detailed Description

TPM2 Protocol as defined in TCG PC Client Platform EFI Protocol Specification Family "2.0". See http://trustedcomputinggroup.org for the latest specification

Copyright (c) 2015, 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 which 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_TCG2_BOOT_HASH_ALG_SHA1   0x00000001

#define EFI_TCG2_BOOT_HASH_ALG_SHA256   0x00000002

#define EFI_TCG2_BOOT_HASH_ALG_SHA384   0x00000004

#define EFI_TCG2_BOOT_HASH_ALG_SHA512   0x00000008

#define EFI_TCG2_BOOT_HASH_ALG_SM3_256   0x00000010

#define EFI_TCG2_EVENT_HEADER_VERSION   1

#define EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2   0x00000001

#define EFI_TCG2_EVENT_LOG_FORMAT_TCG_2   0x00000002

#define EFI_TCG2_EXTEND_ONLY   0x0000000000000001

#define EFI_TCG2_FINAL_EVENTS_TABLE_GUID   {0x1e2ed096, 0x30e2, 0x4254, { 0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25 }}

#define EFI_TCG2_FINAL_EVENTS_TABLE_VERSION   1

#define EFI_TCG2_PROTOCOL_GUID   {0x607f766c, 0x7455, 0x42be, { 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f }}

#define MAX_PCR_INDEX   23

#define PE_COFF_IMAGE   0x0000000000000010


Typedef Documentation

typedef IN UINT32 ActivePcrBanks

typedef IN UINT64 Flags

typedef OUT UINT32* OperationPresent

typedef OUT UINT32 OUT UINT32* Response


Function Documentation

typedef EFI_STATUS ( EFIAPI EFI_TCG2_GET_RESULT_OF_SET_ACTIVE_PCR_BANKS  ) 

The EFI_TCG2_PROTOCOL GetCapability function call provides protocol capability information and state information.

Parameters:
[in] This Indicates the calling context
[in,out] ProtocolCapability The caller allocates memory for a EFI_TCG2_BOOT_SERVICE_CAPABILITY structure and sets the size field to the size of the structure allocated. The callee fills in the fields with the EFI protocol capability information and the current EFI TCG2 state information up to the number of fields which fit within the size of the structure passed in.
Return values:
EFI_SUCCESS Operation completed successfully.
EFI_DEVICE_ERROR The command was unsuccessful. The ProtocolCapability variable will not be populated.
EFI_INVALID_PARAMETER One or more of the parameters are incorrect. The ProtocolCapability variable will not be populated.
EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too small to hold the full response. It will be partially populated (required Size field will be set).
The EFI_TCG2_PROTOCOL Get Event Log function call allows a caller to retrieve the address of a given event log and its last entry.

Parameters:
[in] This Indicates the calling context
[in] EventLogFormat The type of the event log for which the information is requested.
[out] EventLogLocation A pointer to the memory address of the event log.
[out] 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.
[out] EventLogTruncated If the Event Log is missing at least one entry because an event would have exceeded the area allocated for events, this value is set to TRUE. Otherwise, the value will be FALSE and the Event Log will be complete.
Return values:
EFI_SUCCESS Operation completed successfully.
EFI_INVALID_PARAMETER One or more of the parameters are incorrect (e.g. asking for an event log whose format is not supported).
The EFI_TCG2_PROTOCOL HashLogExtendEvent function call provides callers with an opportunity to extend and optionally log events without requiring knowledge of actual TPM commands. The extend operation will occur even if this function cannot create an event log entry (e.g. due to the event log being full).

Parameters:
[in] This Indicates the calling context
[in] Flags Bitmap providing additional information.
[in] DataToHash Physical address of the start of the data buffer to be hashed.
[in] DataToHashLen The length in bytes of the buffer referenced by DataToHash.
[in] EfiTcgEvent Pointer to data buffer containing information about the event.
Return values:
EFI_SUCCESS Operation completed successfully.
EFI_DEVICE_ERROR The command was unsuccessful.
EFI_VOLUME_FULL The extend operation occurred, but the event could not be written to one or more event logs.
EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
EFI_UNSUPPORTED The PE/COFF image type is not supported.
This service enables the sending of commands to the TPM.

Parameters:
[in] This Indicates the calling context
[in] InputParameterBlockSize Size of the TPM input parameter block.
[in] InputParameterBlock Pointer to the TPM input parameter block.
[in] OutputParameterBlockSize Size of the TPM output parameter block.
[in] OutputParameterBlock Pointer to the TPM output parameter block.
Return values:
EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.
EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.
EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
EFI_BUFFER_TOO_SMALL The output parameter block is too small.
This service returns the currently active PCR banks.

Parameters:
[in] This Indicates the calling context
[out] ActivePcrBanks Pointer to the variable receiving the bitmap of currently active PCR banks.
Return values:
EFI_SUCCESS The bitmap of active PCR banks was stored in the ActivePcrBanks parameter.
EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
This service sets the currently active PCR banks.

Parameters:
[in] This Indicates the calling context
[in] ActivePcrBanks Bitmap of the requested active PCR banks. At least one bit SHALL be set.
Return values:
EFI_SUCCESS The bitmap in ActivePcrBank parameter is already active.
EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
This service retrieves the result of a previous invocation of SetActivePcrBanks.

Parameters:
[in] This Indicates the calling context
[out] OperationPresent Non-zero value to indicate a SetActivePcrBank operation was invoked during the last boot.
[out] Response The response from the SetActivePcrBank request.
Return values:
EFI_SUCCESS The result value could be returned.
EFI_INVALID_PARAMETER One or more of the parameters are incorrect.


Variable Documentation


Generated on Thu Sep 24 23:14:21 2015 for MdePkg[ALL] by  doxygen 1.5.7.1