Tpm2CommandLib.h File Reference

#include <IndustryStandard/Tpm20.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	Tpm2HashSequenceStart (IN TPMI_ALG_HASH HashAlg, OUT TPMI_DH_OBJECT *SequenceHandle)
EFI_STATUS EFIAPI	Tpm2SequenceUpdate (IN TPMI_DH_OBJECT SequenceHandle, IN TPM2B_MAX_BUFFER *Buffer)
EFI_STATUS EFIAPI	Tpm2EventSequenceComplete (IN TPMI_DH_PCR PcrHandle, IN TPMI_DH_OBJECT SequenceHandle, IN TPM2B_MAX_BUFFER *Buffer, OUT TPML_DIGEST_VALUES *Results)
EFI_STATUS EFIAPI	Tpm2SequenceComplete (IN TPMI_DH_OBJECT SequenceHandle, IN TPM2B_MAX_BUFFER *Buffer, OUT TPM2B_DIGEST *Result)
EFI_STATUS EFIAPI	Tpm2Startup (IN TPM_SU StartupType)
EFI_STATUS EFIAPI	Tpm2Shutdown (IN TPM_SU ShutdownType)
EFI_STATUS EFIAPI	Tpm2SelfTest (IN TPMI_YES_NO FullTest)
EFI_STATUS EFIAPI	Tpm2SetPrimaryPolicy (IN TPMI_RH_HIERARCHY_AUTH AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession, IN TPM2B_DIGEST *AuthPolicy, IN TPMI_ALG_HASH HashAlg)
EFI_STATUS EFIAPI	Tpm2Clear (IN TPMI_RH_CLEAR AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL)
EFI_STATUS EFIAPI	Tpm2ClearControl (IN TPMI_RH_CLEAR AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL, IN TPMI_YES_NO Disable)
EFI_STATUS EFIAPI	Tpm2HierarchyChangeAuth (IN TPMI_RH_HIERARCHY_AUTH AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession, IN TPM2B_AUTH *NewAuth)
EFI_STATUS EFIAPI	Tpm2ChangeEPS (IN TPMI_RH_PLATFORM AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession)
EFI_STATUS EFIAPI	Tpm2ChangePPS (IN TPMI_RH_PLATFORM AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession)
EFI_STATUS EFIAPI	Tpm2HierarchyControl (IN TPMI_RH_HIERARCHY AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession, IN TPMI_RH_HIERARCHY Hierarchy, IN TPMI_YES_NO State)
EFI_STATUS EFIAPI	Tpm2DictionaryAttackLockReset (IN TPMI_RH_LOCKOUT LockHandle, IN TPMS_AUTH_COMMAND *AuthSession)
EFI_STATUS EFIAPI	Tpm2DictionaryAttackParameters (IN TPMI_RH_LOCKOUT LockHandle, IN TPMS_AUTH_COMMAND *AuthSession, IN UINT32 NewMaxTries, IN UINT32 NewRecoveryTime, IN UINT32 LockoutRecovery)
EFI_STATUS EFIAPI	Tpm2NvReadPublic (IN TPMI_RH_NV_INDEX NvIndex, OUT TPM2B_NV_PUBLIC *NvPublic, OUT TPM2B_NAME *NvName)
EFI_STATUS EFIAPI	Tpm2NvDefineSpace (IN TPMI_RH_PROVISION AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL, IN TPM2B_AUTH *Auth, IN TPM2B_NV_PUBLIC *NvPublic)
EFI_STATUS EFIAPI	Tpm2NvUndefineSpace (IN TPMI_RH_PROVISION AuthHandle, IN TPMI_RH_NV_INDEX NvIndex, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL)
EFI_STATUS EFIAPI	Tpm2NvRead (IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_INDEX NvIndex, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL, IN UINT16 Size, IN UINT16 Offset, IN OUT TPM2B_MAX_BUFFER *OutData)
EFI_STATUS EFIAPI	Tpm2NvWrite (IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_INDEX NvIndex, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL, IN TPM2B_MAX_BUFFER *InData, IN UINT16 Offset)
EFI_STATUS EFIAPI	Tpm2NvReadLock (IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_INDEX NvIndex, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL)
EFI_STATUS EFIAPI	Tpm2NvWriteLock (IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_INDEX NvIndex, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL)
EFI_STATUS EFIAPI	Tpm2NvGlobalWriteLock (IN TPMI_RH_PROVISION AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL)
EFI_STATUS EFIAPI	Tpm2NvExtend (IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_INDEX NvIndex, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL, IN TPM2B_MAX_BUFFER *InData)
EFI_STATUS EFIAPI	Tpm2PcrExtend (IN TPMI_DH_PCR PcrHandle, IN TPML_DIGEST_VALUES *Digests)
EFI_STATUS EFIAPI	Tpm2PcrEvent (IN TPMI_DH_PCR PcrHandle, IN TPM2B_EVENT *EventData, OUT TPML_DIGEST_VALUES *Digests)
EFI_STATUS EFIAPI	Tpm2PcrRead (IN TPML_PCR_SELECTION *PcrSelectionIn, OUT UINT32 *PcrUpdateCounter, OUT TPML_PCR_SELECTION *PcrSelectionOut, OUT TPML_DIGEST *PcrValues)
EFI_STATUS EFIAPI	Tpm2PcrAllocate (IN TPMI_RH_PLATFORM AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession, IN TPML_PCR_SELECTION *PcrAllocation, OUT TPMI_YES_NO *AllocationSuccess, OUT UINT32 *MaxPCR, OUT UINT32 *SizeNeeded, OUT UINT32 *SizeAvailable)
EFI_STATUS EFIAPI	Tpm2PcrAllocateBanks (IN TPM2B_AUTH *PlatformAuth OPTIONAL, IN UINT32 SupportedPCRBanks, IN UINT32 PCRBanks)
EFI_STATUS EFIAPI	Tpm2GetCapability (IN TPM_CAP Capability, IN UINT32 Property, IN UINT32 PropertyCount, OUT TPMI_YES_NO *MoreData, OUT TPMS_CAPABILITY_DATA *CapabilityData)
EFI_STATUS EFIAPI	Tpm2GetCapabilityFamily (OUT CHAR8 *Family)
EFI_STATUS EFIAPI	Tpm2GetCapabilityManufactureID (OUT UINT32 *ManufactureId)
EFI_STATUS EFIAPI	Tpm2GetCapabilityFirmwareVersion (OUT UINT32 *FirmwareVersion1, OUT UINT32 *FirmwareVersion2)
EFI_STATUS EFIAPI	Tpm2GetCapabilityMaxCommandResponseSize (OUT UINT32 *MaxCommandSize, OUT UINT32 *MaxResponseSize)
EFI_STATUS EFIAPI	Tpm2GetCapabilitySupportedAlg (OUT TPML_ALG_PROPERTY *AlgList)
EFI_STATUS EFIAPI	Tpm2GetCapabilityLockoutCounter (OUT UINT32 *LockoutCounter)
EFI_STATUS EFIAPI	Tpm2GetCapabilityLockoutInterval (OUT UINT32 *LockoutInterval)
EFI_STATUS EFIAPI	Tpm2GetCapabilityInputBufferSize (OUT UINT32 *InputBufferSize)
EFI_STATUS EFIAPI	Tpm2GetCapabilityPcrs (OUT TPML_PCR_SELECTION *Pcrs)
EFI_STATUS EFIAPI	Tpm2GetCapabilitySupportedAndActivePcrs (OUT UINT32 *TpmHashAlgorithmBitmap, OUT UINT32 *ActivePcrBanks)
EFI_STATUS EFIAPI	Tpm2GetCapabilityAlgorithmSet (OUT UINT32 *AlgorithmSet)
EFI_STATUS EFIAPI	Tpm2GetCapabilityIsCommandImplemented (IN TPM_CC Command, OUT BOOLEAN *IsCmdImpl)
EFI_STATUS EFIAPI	Tpm2TestParms (IN TPMT_PUBLIC_PARMS *Parameters)
EFI_STATUS EFIAPI	Tpm2SetAlgorithmSet (IN TPMI_RH_PLATFORM AuthHandle, IN TPMS_AUTH_COMMAND *AuthSession, IN UINT32 AlgorithmSet)
EFI_STATUS EFIAPI	Tpm2StartAuthSession (IN TPMI_DH_OBJECT TpmKey, IN TPMI_DH_ENTITY Bind, IN TPM2B_NONCE *NonceCaller, IN TPM2B_ENCRYPTED_SECRET *Salt, IN TPM_SE SessionType, IN TPMT_SYM_DEF *Symmetric, IN TPMI_ALG_HASH AuthHash, OUT TPMI_SH_AUTH_SESSION *SessionHandle, OUT TPM2B_NONCE *NonceTPM)
EFI_STATUS EFIAPI	Tpm2FlushContext (IN TPMI_DH_CONTEXT FlushHandle)
EFI_STATUS EFIAPI	Tpm2PolicySecret (IN TPMI_DH_ENTITY AuthHandle, IN TPMI_SH_POLICY PolicySession, IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL, IN TPM2B_NONCE *NonceTPM, IN TPM2B_DIGEST *CpHashA, IN TPM2B_NONCE *PolicyRef, IN INT32 Expiration, OUT TPM2B_TIMEOUT *Timeout, OUT TPMT_TK_AUTH *PolicyTicket)
EFI_STATUS EFIAPI	Tpm2PolicyOR (IN TPMI_SH_POLICY PolicySession, IN TPML_DIGEST *HashList)
EFI_STATUS EFIAPI	Tpm2PolicyCommandCode (IN TPMI_SH_POLICY PolicySession, IN TPM_CC Code)
EFI_STATUS EFIAPI	Tpm2PolicyGetDigest (IN TPMI_SH_POLICY PolicySession, OUT TPM2B_DIGEST *PolicyHash)
EFI_STATUS EFIAPI	Tpm2ReadPublic (IN TPMI_DH_OBJECT ObjectHandle, OUT TPM2B_PUBLIC *OutPublic, OUT TPM2B_NAME *Name, OUT TPM2B_NAME *QualifiedName)
UINT32 EFIAPI	CopyAuthSessionCommand (IN TPMS_AUTH_COMMAND *AuthSessionIn OPTIONAL, OUT UINT8 *AuthSessionOut)
UINT32 EFIAPI	CopyAuthSessionResponse (IN UINT8 *AuthSessionIn, OUT TPMS_AUTH_RESPONSE *AuthSessionOut OPTIONAL)
UINT16 EFIAPI	GetHashSizeFromAlgo (IN TPMI_ALG_HASH HashAlgo)
UINT32 EFIAPI	GetHashMaskFromAlgo (IN TPMI_ALG_HASH HashAlgo)
BOOLEAN EFIAPI	IsHashAlgSupportedInHashAlgorithmMask (IN TPMI_ALG_HASH HashAlg, IN UINT32 HashAlgorithmMask)
VOID *EFIAPI	CopyDigestListToBuffer (IN OUT VOID *Buffer, IN TPML_DIGEST_VALUES *DigestList, IN UINT32 HashAlgorithmMask)
UINT32 EFIAPI	GetDigestListSize (IN TPML_DIGEST_VALUES *DigestList)
EFI_STATUS EFIAPI	GetDigestFromDigestList (IN TPMI_ALG_HASH HashAlg, IN TPML_DIGEST_VALUES *DigestList, OUT VOID *Digest)
EFI_STATUS EFIAPI	Tpm2PcrReadForActiveBank (IN TPMI_DH_PCR PcrHandle, OUT TPML_DIGEST *HashList)

Detailed Description

This library is used by other modules to send TPM2 command.

Copyright (c) 2013 - 2024, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Tpm2CommandLib.h.

Function Documentation

CopyAuthSessionCommand()

UINT32 EFIAPI CopyAuthSessionCommand	(	IN TPMS_AUTH_COMMAND *AuthSessionIn	OPTIONAL,
		OUT UINT8 *	AuthSessionOut
	)

Copy AuthSessionIn to TPM2 command buffer.

Parameters

[in]	AuthSessionIn	Input AuthSession data
[out]	AuthSessionOut	Output AuthSession data in TPM2 command buffer

Returns

AuthSession size

Definition at line 88 of file Tpm2Help.c.

CopyAuthSessionResponse()

UINT32 EFIAPI CopyAuthSessionResponse	(	IN UINT8 *	AuthSessionIn,
		OUT TPMS_AUTH_RESPONSE *AuthSessionOut	OPTIONAL
	)

Copy AuthSessionIn from TPM2 response buffer.

Parameters

[in]	AuthSessionIn	Input AuthSession data in TPM2 response buffer
[out]	AuthSessionOut	Output AuthSession data

Returns

AuthSession size

Copy AuthSessionIn from TPM2 response buffer.

Parameters

[in]	AuthSessionIn	Input AuthSession data in TPM2 response buffer
[out]	AuthSessionOut	Output AuthSession data

Returns

0 copy failed else AuthSession size

Definition at line 154 of file Tpm2Help.c.

CopyDigestListToBuffer()

VOID *EFIAPI CopyDigestListToBuffer	(	IN OUT VOID *	Buffer,
		IN TPML_DIGEST_VALUES *	DigestList,
		IN UINT32	HashAlgorithmMask
	)

Copy TPML_DIGEST_VALUES into a buffer

Parameters

[in,out]	Buffer	Buffer to hold copied TPML_DIGEST_VALUES compact binary.
[in]	DigestList	TPML_DIGEST_VALUES to be copied.
[in]	HashAlgorithmMask	HASH bits corresponding to the desired digests to copy.

Returns

The end of buffer to hold TPML_DIGEST_VALUES.

Definition at line 201 of file TdTcg2Dxe.c.

GetDigestFromDigestList()

EFI_STATUS EFIAPI GetDigestFromDigestList	(	IN TPMI_ALG_HASH	HashAlg,
		IN TPML_DIGEST_VALUES *	DigestList,
		OUT VOID *	Digest
	)

This function get digest from digest list.

Parameters

[in]	HashAlg	Digest algorithm
[in]	DigestList	Digest list
[out]	Digest	Digest

Return values

EFI_SUCCESS	Digest is found and returned.
EFI_NOT_FOUND	Digest is not found.

Definition at line 331 of file Tpm2Help.c.

GetDigestListSize()

UINT32 EFIAPI GetDigestListSize

(

IN TPML_DIGEST_VALUES *

DigestList

)

Get TPML_DIGEST_VALUES data size.

Parameters

[in]

DigestList

TPML_DIGEST_VALUES data.

Returns

TPML_DIGEST_VALUES data size.

Definition at line 302 of file Tpm2Help.c.

GetHashMaskFromAlgo()

UINT32 EFIAPI GetHashMaskFromAlgo

(

IN TPMI_ALG_HASH

HashAlgo

)

Get hash mask from algorithm.

Parameters

[in]

HashAlgo

Hash algorithm

Returns

Hash mask

Get hash mask based on Algo

Parameters

[in]

HashAlgo

Hash Algorithm Id.

Returns

Hash mask.

Definition at line 175 of file TdTcg2Dxe.c.

GetHashSizeFromAlgo()

UINT16 EFIAPI GetHashSizeFromAlgo

(

IN TPMI_ALG_HASH

HashAlgo

)

Return size of digest.

Parameters

[in]

HashAlgo

Hash algorithm

Returns

size of digest

Get hash size based on Algo

Parameters

[in]

HashAlgo

Hash Algorithm Id.

Returns

Size of the hash.

Definition at line 152 of file TdTcg2Dxe.c.

IsHashAlgSupportedInHashAlgorithmMask()

BOOLEAN EFIAPI IsHashAlgSupportedInHashAlgorithmMask	(	IN TPMI_ALG_HASH	HashAlg,
		IN UINT32	HashAlgorithmMask
	)

Return if hash alg is supported in HashAlgorithmMask.

Parameters

HashAlg	Hash algorithm to be checked.
HashAlgorithmMask	Bitfield of allowed hash algorithms.

Return values

TRUE	Hash algorithm is supported.
FALSE	Hash algorithm is not supported.

Definition at line 208 of file Tpm2Help.c.

Tpm2ChangeEPS()

EFI_STATUS EFIAPI Tpm2ChangeEPS	(	IN TPMI_RH_PLATFORM	AuthHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession
	)

This replaces the current EPS with a value from the RNG and sets the Endorsement hierarchy controls to their default initialization values.

Parameters

[in]	AuthHandle	TPM_RH_PLATFORM+{PP}
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 508 of file Tpm2Hierarchy.c.

Tpm2ChangePPS()

EFI_STATUS EFIAPI Tpm2ChangePPS	(	IN TPMI_RH_PLATFORM	AuthHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession
	)

This replaces the current PPS with a value from the RNG and sets platformPolicy to the default initialization value (the Empty Buffer).

Parameters

[in]	AuthHandle	TPM_RH_PLATFORM+{PP}
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 606 of file Tpm2Hierarchy.c.

Tpm2Clear()

EFI_STATUS EFIAPI Tpm2Clear	(	IN TPMI_RH_CLEAR	AuthHandle,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL
	)

This command removes all TPM context associated with a specific Owner.

Parameters

[in]	AuthHandle	TPM_RH_LOCKOUT or TPM_RH_PLATFORM+{PP}
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 218 of file Tpm2Hierarchy.c.

Tpm2ClearControl()

EFI_STATUS EFIAPI Tpm2ClearControl	(	IN TPMI_RH_CLEAR	AuthHandle,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL,
		IN TPMI_YES_NO	Disable
	)

Disables and enables the execution of TPM2_Clear().

Parameters

[in]	AuthHandle	TPM_RH_LOCKOUT or TPM_RH_PLATFORM+{PP}
[in]	AuthSession	Auth Session context
[in]	Disable	YES if the disableOwnerClear flag is to be SET, NO if the flag is to be CLEAR.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 307 of file Tpm2Hierarchy.c.

Tpm2DictionaryAttackLockReset()

EFI_STATUS EFIAPI Tpm2DictionaryAttackLockReset	(	IN TPMI_RH_LOCKOUT	LockHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession
	)

This command cancels the effect of a TPM lockout due to a number of successive authorization failures. If this command is properly authorized, the lockout counter is set to zero.

Parameters

[in]	LockHandle	LockHandle
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

This command cancels the effect of a TPM lockout due to a number of successive authorization failures. If this command is properly authorized, the lockout counter is set to zero.

Parameters

[in]	LockHandle	TPM_RH_LOCKOUT
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 61 of file Tpm2DictionaryAttack.c.

Tpm2DictionaryAttackParameters()

EFI_STATUS EFIAPI Tpm2DictionaryAttackParameters	(	IN TPMI_RH_LOCKOUT	LockHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession,
		IN UINT32	NewMaxTries,
		IN UINT32	NewRecoveryTime,
		IN UINT32	LockoutRecovery
	)

This command cancels the effect of a TPM lockout due to a number of successive authorization failures. If this command is properly authorized, the lockout counter is set to zero.

Parameters

[in]	LockHandle	LockHandle
[in]	AuthSession	Auth Session context
[in]	NewMaxTries	Count of authorization failures before the lockout is imposed
[in]	NewRecoveryTime	Time in seconds before the authorization failure count is automatically decremented
[in]	LockoutRecovery	Time in seconds after a lockoutAuth failure before use of lockoutAuth is allowed

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

This command cancels the effect of a TPM lockout due to a number of successive authorization failures. If this command is properly authorized, the lockout counter is set to zero.

Parameters

[in]	LockHandle	TPM_RH_LOCKOUT
[in]	AuthSession	Auth Session context
[in]	NewMaxTries	Count of authorization failures before the lockout is imposed
[in]	NewRecoveryTime	Time in seconds before the authorization failure count is automatically decremented
[in]	LockoutRecovery	Time in seconds after a lockoutAuth failure before use of lockoutAuth is allowed

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 140 of file Tpm2DictionaryAttack.c.

Tpm2EventSequenceComplete()

EFI_STATUS EFIAPI Tpm2EventSequenceComplete	(	IN TPMI_DH_PCR	PcrHandle,
		IN TPMI_DH_OBJECT	SequenceHandle,
		IN TPM2B_MAX_BUFFER *	Buffer,
		OUT TPML_DIGEST_VALUES *	Results
	)

This command adds the last part of data, if any, to an Event sequence and returns the result in a digest list. If pcrHandle references a PCR and not TPM_RH_NULL, then the returned digest list is processed in the same manner as the digest list input parameter to TPM2_PCR_Extend() with the pcrHandle in each bank extended with the associated digest value.

Parameters

[in]	PcrHandle	PCR to be extended with the Event data
[in]	SequenceHandle	Authorization for the sequence
[in]	Buffer	Data to be added to the Event
[out]	Results	List of digests computed for the PCR

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 280 of file Tpm2Sequences.c.

Tpm2FlushContext()

EFI_STATUS EFIAPI Tpm2FlushContext

(

IN TPMI_DH_CONTEXT

FlushHandle

)

This command causes all context associated with a loaded object or session to be removed from TPM memory.

Parameters

[in]

FlushHandle

The handle of the item to flush.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 39 of file Tpm2Context.c.

Tpm2GetCapability()

EFI_STATUS EFIAPI Tpm2GetCapability	(	IN TPM_CAP	Capability,
		IN UINT32	Property,
		IN UINT32	PropertyCount,
		OUT TPMI_YES_NO *	MoreData,
		OUT TPMS_CAPABILITY_DATA *	CapabilityData
	)

This command returns various information regarding the TPM and its current state.

The capability parameter determines the category of data returned. The property parameter selects the first value of the selected category to be returned. If there is no property that corresponds to the value of property, the next higher value is returned, if it exists. The moreData parameter will have a value of YES if there are more values of the requested type that were not returned. If no next capability exists, the TPM will return a zero-length list and moreData will have a value of NO.

NOTE: To simplify this function, leave returned CapabilityData for caller to unpack since there are many capability categories and only few categories will be used in firmware. It means the caller need swap the byte order for the fields in CapabilityData.

Parameters

[in]	Capability	Group selection; determines the format of the response.
[in]	Property	Further definition of information.
[in]	PropertyCount	Number of properties of the indicated type to return.
[out]	MoreData	Flag to indicate if there are more values of this type.
[out]	CapabilityData	The capability data.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 71 of file Tpm2Capability.c.

Tpm2GetCapabilityAlgorithmSet()

EFI_STATUS EFIAPI Tpm2GetCapabilityAlgorithmSet

(

OUT UINT32 *

AlgorithmSet

)

This command returns the information of TPM AlgorithmSet.

This function parse the value got from TPM2_GetCapability and return the AlgorithmSet.

Parameters

[out]

AlgorithmSet

The AlgorithmSet of TPM.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 635 of file Tpm2Capability.c.

Tpm2GetCapabilityFamily()

EFI_STATUS EFIAPI Tpm2GetCapabilityFamily

(

OUT CHAR8 *

Family

)

This command returns the information of TPM Family.

This function parse the value got from TPM2_GetCapability and return the Family.

Parameters

[out]

Family

The Family of TPM. (a 4-octet character string)

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 143 of file Tpm2Capability.c.

Tpm2GetCapabilityFirmwareVersion()

EFI_STATUS EFIAPI Tpm2GetCapabilityFirmwareVersion	(	OUT UINT32 *	FirmwareVersion1,
		OUT UINT32 *	FirmwareVersion2
	)

This command returns the information of TPM FirmwareVersion.

This function parse the value got from TPM2_GetCapability and return the TPM FirmwareVersion.

Parameters

[out]	FirmwareVersion1	The FirmwareVersion1.
[out]	FirmwareVersion2	The FirmwareVersion2.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 216 of file Tpm2Capability.c.

Tpm2GetCapabilityInputBufferSize()

EFI_STATUS EFIAPI Tpm2GetCapabilityInputBufferSize

(

OUT UINT32 *

InputBufferSize

)

This command returns the information of TPM InputBufferSize.

This function parse the value got from TPM2_GetCapability and return the InputBufferSize.

Parameters

[out]

InputBufferSize

The InputBufferSize of TPM. the maximum size of a parameter (typically, a TPM2B_MAX_BUFFER)

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 438 of file Tpm2Capability.c.

Tpm2GetCapabilityIsCommandImplemented()

EFI_STATUS EFIAPI Tpm2GetCapabilityIsCommandImplemented	(	IN TPM_CC	Command,
		OUT BOOLEAN *	IsCmdImpl
	)

This function will query if the command is supported.

Parameters

	[In]	Command TPM_CC command starts from TPM_CC_FIRST.
[out]	IsCmdImpl	The command is supported or not.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 670 of file Tpm2Capability.c.

Tpm2GetCapabilityLockoutCounter()

EFI_STATUS EFIAPI Tpm2GetCapabilityLockoutCounter

(

OUT UINT32 *

LockoutCounter

)

This command returns the information of TPM LockoutCounter.

This function parse the value got from TPM2_GetCapability and return the LockoutCounter.

Parameters

[out]

LockoutCounter

The LockoutCounter of TPM.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 365 of file Tpm2Capability.c.

Tpm2GetCapabilityLockoutInterval()

EFI_STATUS EFIAPI Tpm2GetCapabilityLockoutInterval

(

OUT UINT32 *

LockoutInterval

)

This command returns the information of TPM LockoutInterval.

This function parse the value got from TPM2_GetCapability and return the LockoutInterval.

Parameters

[out]

LockoutInterval

The LockoutInterval of TPM.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 401 of file Tpm2Capability.c.

Tpm2GetCapabilityManufactureID()

EFI_STATUS EFIAPI Tpm2GetCapabilityManufactureID

(

OUT UINT32 *

ManufactureId

)

This command returns the information of TPM manufacture ID.

This function parse the value got from TPM2_GetCapability and return the TPM manufacture ID.

Parameters

[out]

ManufactureId

The manufacture ID of TPM.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 179 of file Tpm2Capability.c.

Tpm2GetCapabilityMaxCommandResponseSize()

EFI_STATUS EFIAPI Tpm2GetCapabilityMaxCommandResponseSize	(	OUT UINT32 *	MaxCommandSize,
		OUT UINT32 *	MaxResponseSize
	)

This command returns the information of the maximum value for commandSize and responseSize in a command.

This function parse the value got from TPM2_GetCapability and return the max command size and response size

Parameters

[out]	MaxCommandSize	The maximum value for commandSize in a command.
[out]	MaxResponseSize	The maximum value for responseSize in a command.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 267 of file Tpm2Capability.c.

Tpm2GetCapabilityPcrs()

EFI_STATUS EFIAPI Tpm2GetCapabilityPcrs

(

OUT TPML_PCR_SELECTION *

Pcrs

)

This command returns the information of TPM PCRs.

This function parse the value got from TPM2_GetCapability and return the PcrSelection.

Parameters

[out]

Pcrs

The Pcr Selection

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 474 of file Tpm2Capability.c.

Tpm2GetCapabilitySupportedAlg()

EFI_STATUS EFIAPI Tpm2GetCapabilitySupportedAlg

(

OUT TPML_ALG_PROPERTY *

AlgList

)

This command returns Returns a list of TPMS_ALG_PROPERTIES. Each entry is an algorithm ID and a set of properties of the algorithm.

This function parse the value got from TPM2_GetCapability and return the list.

Parameters

[out]

AlgList

List of algorithm.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 317 of file Tpm2Capability.c.

Tpm2GetCapabilitySupportedAndActivePcrs()

EFI_STATUS EFIAPI Tpm2GetCapabilitySupportedAndActivePcrs	(	OUT UINT32 *	TpmHashAlgorithmBitmap,
		OUT UINT32 *	ActivePcrBanks
	)

This function will query the TPM to determine which hashing algorithms are supported and which PCR banks are currently active.

Parameters

[out]	TpmHashAlgorithmBitmap	A bitmask containing the algorithms supported by the TPM.
[out]	ActivePcrBanks	A bitmask containing the PCRs currently allocated.

Return values

EFI_SUCCESS	TPM was successfully queried and return values can be trusted.
Others	An error occurred, likely in communication with the TPM.

Definition at line 527 of file Tpm2Capability.c.

Tpm2HashSequenceStart()

EFI_STATUS EFIAPI Tpm2HashSequenceStart	(	IN TPMI_ALG_HASH	HashAlg,
		OUT TPMI_DH_OBJECT *	SequenceHandle
	)

This command starts a hash or an Event sequence. If hashAlg is an implemented hash, then a hash sequence is started. If hashAlg is TPM_ALG_NULL, then an Event sequence is started.

Parameters

[in]	HashAlg	The hash algorithm to use for the hash sequence An Event sequence starts if this is TPM_ALG_NULL.
[out]	SequenceHandle	A handle to reference the sequence

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 93 of file Tpm2Sequences.c.

Tpm2HierarchyChangeAuth()

EFI_STATUS EFIAPI Tpm2HierarchyChangeAuth	(	IN TPMI_RH_HIERARCHY_AUTH	AuthHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession,
		IN TPM2B_AUTH *	NewAuth
	)

This command allows the authorization secret for a hierarchy or lockout to be changed using the current authorization value as the command authorization.

Parameters

[in]	AuthHandle	TPM_RH_LOCKOUT, TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}
[in]	AuthSession	Auth Session context
[in]	NewAuth	New authorization secret

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 401 of file Tpm2Hierarchy.c.

Tpm2HierarchyControl()

EFI_STATUS EFIAPI Tpm2HierarchyControl	(	IN TPMI_RH_HIERARCHY	AuthHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession,
		IN TPMI_RH_HIERARCHY	Hierarchy,
		IN TPMI_YES_NO	State
	)

This command enables and disables use of a hierarchy.

Parameters

[in]	AuthHandle	TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}
[in]	AuthSession	Auth Session context
[in]	Hierarchy	Hierarchy of the enable being modified
[in]	State	YES if the enable should be SET, NO if the enable should be CLEAR

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 706 of file Tpm2Hierarchy.c.

Tpm2NvDefineSpace()

EFI_STATUS EFIAPI Tpm2NvDefineSpace	(	IN TPMI_RH_PROVISION	AuthHandle,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL,
		IN TPM2B_AUTH *	Auth,
		IN TPM2B_NV_PUBLIC *	NvPublic
	)

This command defines the attributes of an NV Index and causes the TPM to reserve space to hold the data associated with the index. If a definition already exists at the index, the TPM will return TPM_RC_NV_DEFINED.

Parameters

[in]	AuthHandle	TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.
[in]	AuthSession	Auth Session context
[in]	Auth	The authorization data.
[in]	NvPublic	The public area of the index.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_ALREADY_STARTED	The command was returned successfully, but NvIndex is already defined.

Definition at line 300 of file Tpm2NVStorage.c.

Tpm2NvExtend()

EFI_STATUS EFIAPI Tpm2NvExtend	(	IN TPMI_RH_NV_AUTH	AuthHandle,
		IN TPMI_RH_NV_INDEX	NvIndex,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL,
		IN TPM2B_MAX_BUFFER *	InData
	)

This command extends a value to an area in NV memory that was previously defined by TPM2_NV_DefineSpace().

Parameters

[in]	AuthHandle	the handle indicating the source of the authorization value.
[in]	NvIndex	The NV Index of the area to extend.
[in]	AuthSession	Auth Session context
[in]	InData	The data to extend.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 1086 of file Tpm2NVStorage.c.

Tpm2NvGlobalWriteLock()

EFI_STATUS EFIAPI Tpm2NvGlobalWriteLock	(	IN TPMI_RH_PROVISION	AuthHandle,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL
	)

The command will SET TPMA_NV_WRITELOCKED for all indexes that have their TPMA_NV_GLOBALLOCK attribute SET.

Parameters

[in]	AuthHandle	TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 999 of file Tpm2NVStorage.c.

Tpm2NvRead()

EFI_STATUS EFIAPI Tpm2NvRead	(	IN TPMI_RH_NV_AUTH	AuthHandle,
		IN TPMI_RH_NV_INDEX	NvIndex,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL,
		IN UINT16	Size,
		IN UINT16	Offset,
		IN OUT TPM2B_MAX_BUFFER *	OutData
	)

This command reads a value from an area in NV memory previously defined by TPM2_NV_DefineSpace().

Parameters

[in]	AuthHandle	the handle indicating the source of the authorization value.
[in]	NvIndex	The index to be read.
[in]	AuthSession	Auth Session context
[in]	Size	Number of bytes to read.
[in]	Offset	Byte offset into the area.
[in,out]	OutData	The data read.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 545 of file Tpm2NVStorage.c.

Tpm2NvReadLock()

EFI_STATUS EFIAPI Tpm2NvReadLock	(	IN TPMI_RH_NV_AUTH	AuthHandle,
		IN TPMI_RH_NV_INDEX	NvIndex,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL
	)

This command may be used to prevent further reads of the Index until the next TPM2_Startup (TPM_SU_CLEAR).

Parameters

[in]	AuthHandle	the handle indicating the source of the authorization value.
[in]	NvIndex	The NV Index of the area to lock.
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 824 of file Tpm2NVStorage.c.

Tpm2NvReadPublic()

EFI_STATUS EFIAPI Tpm2NvReadPublic	(	IN TPMI_RH_NV_INDEX	NvIndex,
		OUT TPM2B_NV_PUBLIC *	NvPublic,
		OUT TPM2B_NAME *	NvName
	)

This command is used to read the public area and Name of an NV Index.

Parameters

[in]	NvIndex	The NV Index.
[out]	NvPublic	The public area of the index.
[out]	NvName	The Name of the nvIndex.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

This command is used to read the public area and Name of an NV Index.

Parameters

[in]	NvIndex	The NV Index.
[out]	NvPublic	The public area of the index.
[out]	NvName	The Name of the nvIndex.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 182 of file Tpm2NVStorage.c.

Tpm2NvUndefineSpace()

EFI_STATUS EFIAPI Tpm2NvUndefineSpace	(	IN TPMI_RH_PROVISION	AuthHandle,
		IN TPMI_RH_NV_INDEX	NvIndex,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL
	)

This command removes an index from the TPM.

Parameters

[in]	AuthHandle	TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.
[in]	NvIndex	The NV Index.
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 437 of file Tpm2NVStorage.c.

Tpm2NvWrite()

EFI_STATUS EFIAPI Tpm2NvWrite	(	IN TPMI_RH_NV_AUTH	AuthHandle,
		IN TPMI_RH_NV_INDEX	NvIndex,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL,
		IN TPM2B_MAX_BUFFER *	InData,
		IN UINT16	Offset
	)

This command writes a value to an area in NV memory that was previously defined by TPM2_NV_DefineSpace().

Parameters

[in]	AuthHandle	the handle indicating the source of the authorization value.
[in]	NvIndex	The NV Index of the area to write.
[in]	AuthSession	Auth Session context
[in]	InData	The data to write.
[in]	Offset	The offset into the NV Area.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 693 of file Tpm2NVStorage.c.

Tpm2NvWriteLock()

EFI_STATUS EFIAPI Tpm2NvWriteLock	(	IN TPMI_RH_NV_AUTH	AuthHandle,
		IN TPMI_RH_NV_INDEX	NvIndex,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL
	)

This command may be used to inhibit further writes of the Index.

Parameters

[in]	AuthHandle	the handle indicating the source of the authorization value.
[in]	NvIndex	The NV Index of the area to lock.
[in]	AuthSession	Auth Session context

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.
EFI_NOT_FOUND	The command was returned successfully, but NvIndex is not found.

Definition at line 912 of file Tpm2NVStorage.c.

Tpm2PcrAllocate()

EFI_STATUS EFIAPI Tpm2PcrAllocate	(	IN TPMI_RH_PLATFORM	AuthHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession,
		IN TPML_PCR_SELECTION *	PcrAllocation,
		OUT TPMI_YES_NO *	AllocationSuccess,
		OUT UINT32 *	MaxPCR,
		OUT UINT32 *	SizeNeeded,
		OUT UINT32 *	SizeAvailable
	)

This command is used to set the desired PCR allocation of PCR and algorithms.

Parameters

[in]	AuthHandle	TPM_RH_PLATFORM+{PP}
[in]	AuthSession	Auth Session context
[in]	PcrAllocation	The requested allocation
[out]	AllocationSuccess	YES if the allocation succeeded
[out]	MaxPCR	maximum number of PCR that may be in a bank
[out]	SizeNeeded	number of octets required to satisfy the request
[out]	SizeAvailable	Number of octets available. Computed before the allocation

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 475 of file Tpm2Integrity.c.

Tpm2PcrAllocateBanks()

EFI_STATUS EFIAPI Tpm2PcrAllocateBanks	(	IN TPM2B_AUTH *PlatformAuth	OPTIONAL,
		IN UINT32	SupportedPCRBanks,
		IN UINT32	PCRBanks
	)

Alloc PCR data.

Parameters

[in]	PlatformAuth	platform auth value. NULL means no platform auth change.
[in]	SupportedPCRBanks	Supported PCR banks
[in]	PCRBanks	PCR banks

Return values

EFI_SUCCESS

Operation completed successfully.

Definition at line 598 of file Tpm2Integrity.c.

Tpm2PcrEvent()

EFI_STATUS EFIAPI Tpm2PcrEvent	(	IN TPMI_DH_PCR	PcrHandle,
		IN TPM2B_EVENT *	EventData,
		OUT TPML_DIGEST_VALUES *	Digests
	)

This command is used to cause an update to the indicated PCR. The data in eventData is hashed using the hash algorithm associated with each bank in which the indicated PCR has been allocated. After the data is hashed, the digests list is returned. If the pcrHandle references an implemented PCR and not TPM_ALG_NULL, digests list is processed as in TPM2_PCR_Extend(). A TPM shall support an Event.size of zero through 1,024 inclusive.

Parameters

[in]	PcrHandle	Handle of the PCR
[in]	EventData	Event data in sized buffer
[out]	Digests	List of digest

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 223 of file Tpm2Integrity.c.

Tpm2PcrExtend()

EFI_STATUS EFIAPI Tpm2PcrExtend	(	IN TPMI_DH_PCR	PcrHandle,
		IN TPML_DIGEST_VALUES *	Digests
	)

This command is used to cause an update to the indicated PCR. The digests parameter contains one or more tagged digest value identified by an algorithm ID. For each digest, the PCR associated with pcrHandle is Extended into the bank identified by the tag (hashAlg).

Parameters

[in]	PcrHandle	Handle of the PCR
[in]	Digests	List of tagged digest values to be extended

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 92 of file Tpm2Integrity.c.

Tpm2PcrRead()

EFI_STATUS EFIAPI Tpm2PcrRead	(	IN TPML_PCR_SELECTION *	PcrSelectionIn,
		OUT UINT32 *	PcrUpdateCounter,
		OUT TPML_PCR_SELECTION *	PcrSelectionOut,
		OUT TPML_DIGEST *	PcrValues
	)

This command returns the values of all PCR specified in pcrSelect.

Parameters

[in]	PcrSelectionIn	The selection of PCR to read.
[out]	PcrUpdateCounter	The current value of the PCR update counter.
[out]	PcrSelectionOut	The PCR in the returned list.
[out]	PcrValues	The contents of the PCR indicated in pcrSelect.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 337 of file Tpm2Integrity.c.

Tpm2PcrReadForActiveBank()

EFI_STATUS EFIAPI Tpm2PcrReadForActiveBank	(	IN TPMI_DH_PCR	PcrHandle,
		OUT TPML_DIGEST *	HashList
	)

This function will query the TPM to determine which hashing algorithms and get the digests of all active and supported PCR banks of a specific PCR register.

Parameters

[in]	PcrHandle	The index of the PCR register to be read.
[out]	HashList	List of digests from PCR register being read.

Return values

EFI_SUCCESS	The Pcr was read successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 743 of file Tpm2Integrity.c.

Tpm2PolicyCommandCode()

EFI_STATUS EFIAPI Tpm2PolicyCommandCode	(	IN TPMI_SH_POLICY	PolicySession,
		IN TPM_CC	Code
	)

This command indicates that the authorization will be limited to a specific command code.

Parameters

[in]	PolicySession	Handle for the policy session being extended.
[in]	Code	The allowed commandCode.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 290 of file Tpm2EnhancedAuthorization.c.

Tpm2PolicyGetDigest()

EFI_STATUS EFIAPI Tpm2PolicyGetDigest	(	IN TPMI_SH_POLICY	PolicySession,
		OUT TPM2B_DIGEST *	PolicyHash
	)

This command returns the current policyDigest of the session. This command allows the TPM to be used to perform the actions required to precompute the authPolicy for an object.

Parameters

[in]	PolicySession	Handle for the policy session.
[out]	PolicyHash	the current value of the policyHash of policySession.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 347 of file Tpm2EnhancedAuthorization.c.

Tpm2PolicyOR()

EFI_STATUS EFIAPI Tpm2PolicyOR	(	IN TPMI_SH_POLICY	PolicySession,
		IN TPML_DIGEST *	HashList
	)

This command allows options in authorizations without requiring that the TPM evaluate all of the options. If a policy may be satisfied by different sets of conditions, the TPM need only evaluate one set that satisfies the policy. This command will indicate that one of the required sets of conditions has been satisfied.

Parameters

[in]	PolicySession	Handle for the policy session being extended.
[in]	HashList	the list of hashes to check for a match.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 224 of file Tpm2EnhancedAuthorization.c.

Tpm2PolicySecret()

EFI_STATUS EFIAPI Tpm2PolicySecret	(	IN TPMI_DH_ENTITY	AuthHandle,
		IN TPMI_SH_POLICY	PolicySession,
		IN TPMS_AUTH_COMMAND *AuthSession	OPTIONAL,
		IN TPM2B_NONCE *	NonceTPM,
		IN TPM2B_DIGEST *	CpHashA,
		IN TPM2B_NONCE *	PolicyRef,
		IN INT32	Expiration,
		OUT TPM2B_TIMEOUT *	Timeout,
		OUT TPMT_TK_AUTH *	PolicyTicket
	)

This command includes a secret-based authorization to a policy. The caller proves knowledge of the secret value using an authorization session using the authValue associated with authHandle.

Parameters

[in]	AuthHandle	Handle for an entity providing the authorization
[in]	PolicySession	Handle for the policy session being extended.
[in]	AuthSession	Auth Session context
[in]	NonceTPM	The policy nonce for the session.
[in]	CpHashA	Digest of the command parameters to which this authorization is limited.
[in]	PolicyRef	A reference to a policy relating to the authorization.
[in]	Expiration	Time when authorization will expire, measured in seconds from the time that nonceTPM was generated.
[out]	Timeout	Time value used to indicate to the TPM when the ticket expires.
[out]	PolicyTicket	A ticket that includes a value indicating when the authorization expires.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 90 of file Tpm2EnhancedAuthorization.c.

Tpm2ReadPublic()

EFI_STATUS EFIAPI Tpm2ReadPublic	(	IN TPMI_DH_OBJECT	ObjectHandle,
		OUT TPM2B_PUBLIC *	OutPublic,
		OUT TPM2B_NAME *	Name,
		OUT TPM2B_NAME *	QualifiedName
	)

This command allows access to the public area of a loaded object.

Parameters

[in]	ObjectHandle	TPM handle of an object
[out]	OutPublic	Structure containing the public area of an object
[out]	Name	Name of the object
[out]	QualifiedName	The Qualified Name of the object

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 45 of file Tpm2Object.c.

Tpm2SelfTest()

EFI_STATUS EFIAPI Tpm2SelfTest

(

IN TPMI_YES_NO

FullTest

)

This command causes the TPM to perform a test of its capabilities. If the fullTest is YES, the TPM will test all functions. If fullTest = NO, the TPM will only test those functions that have not previously been tested.

Parameters

[in]

FullTest

YES if full test to be performed NO if only test of untested functions required

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 42 of file Tpm2Test.c.

Tpm2SequenceComplete()

EFI_STATUS EFIAPI Tpm2SequenceComplete	(	IN TPMI_DH_OBJECT	SequenceHandle,
		IN TPM2B_MAX_BUFFER *	Buffer,
		OUT TPM2B_DIGEST *	Result
	)

This command adds the last part of data, if any, to a hash/HMAC sequence and returns the result.

Parameters

[in]	SequenceHandle	Authorization for the sequence
[in]	Buffer	Data to be added to the hash/HMAC
[out]	Result	The returned HMAC or digest in a sized buffer

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 412 of file Tpm2Sequences.c.

Tpm2SequenceUpdate()

EFI_STATUS EFIAPI Tpm2SequenceUpdate	(	IN TPMI_DH_OBJECT	SequenceHandle,
		IN TPM2B_MAX_BUFFER *	Buffer
	)

This command is used to add data to a hash or HMAC sequence. The amount of data in buffer may be any size up to the limits of the TPM. NOTE: In all TPM, a buffer size of 1,024 octets is allowed.

Parameters

[in]	SequenceHandle	Handle for the sequence object
[in]	Buffer	Data to be added to hash

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 181 of file Tpm2Sequences.c.

Tpm2SetAlgorithmSet()

EFI_STATUS EFIAPI Tpm2SetAlgorithmSet	(	IN TPMI_RH_PLATFORM	AuthHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession,
		IN UINT32	AlgorithmSet
	)

This command allows the platform to change the set of algorithms that are used by the TPM. The algorithmSet setting is a vendor-dependent value.

Parameters

[in]	AuthHandle	TPM_RH_PLATFORM
[in]	AuthSession	Auth Session context
[in]	AlgorithmSet	A TPM vendor-dependent value indicating the algorithm set selection

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 48 of file Tpm2Miscellaneous.c.

Tpm2SetPrimaryPolicy()

EFI_STATUS EFIAPI Tpm2SetPrimaryPolicy	(	IN TPMI_RH_HIERARCHY_AUTH	AuthHandle,
		IN TPMS_AUTH_COMMAND *	AuthSession,
		IN TPM2B_DIGEST *	AuthPolicy,
		IN TPMI_ALG_HASH	HashAlg
	)

This command allows setting of the authorization policy for the platform hierarchy (platformPolicy), the storage hierarchy (ownerPolicy), and and the endorsement hierarchy (endorsementPolicy).

Parameters

[in]	AuthHandle	TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP} parameters to be validated
[in]	AuthSession	Auth Session context
[in]	AuthPolicy	An authorization policy hash
[in]	HashAlg	The hash algorithm to use for the policy

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 131 of file Tpm2Hierarchy.c.

Tpm2Shutdown()

EFI_STATUS EFIAPI Tpm2Shutdown

(

IN TPM_SU

ShutdownType

)

Send Shutdown command to TPM2.

Parameters

[in]

ShutdownType

TPM_SU_CLEAR or TPM_SU_STATE.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 95 of file Tpm2Startup.c.

Tpm2StartAuthSession()

EFI_STATUS EFIAPI Tpm2StartAuthSession	(	IN TPMI_DH_OBJECT	TpmKey,
		IN TPMI_DH_ENTITY	Bind,
		IN TPM2B_NONCE *	NonceCaller,
		IN TPM2B_ENCRYPTED_SECRET *	Salt,
		IN TPM_SE	SessionType,
		IN TPMT_SYM_DEF *	Symmetric,
		IN TPMI_ALG_HASH	AuthHash,
		OUT TPMI_SH_AUTH_SESSION *	SessionHandle,
		OUT TPM2B_NONCE *	NonceTPM
	)

This command is used to start an authorization session using alternative methods of establishing the session key (sessionKey) that is used for authorization and encrypting value.

Parameters

[in]	TpmKey	Handle of a loaded decrypt key used to encrypt salt.
[in]	Bind	Entity providing the authValue.
[in]	NonceCaller	Initial nonceCaller, sets nonce size for the session.
[in]	Salt	Value encrypted according to the type of tpmKey.
[in]	SessionType	Indicates the type of the session.
[in]	Symmetric	The algorithm and key size for parameter encryption.
[in]	AuthHash	Hash algorithm to use for the session.
[out]	SessionHandle	Handle for the newly created session.
[out]	NonceTPM	The initial nonce from the TPM, used in the computation of the sessionKey.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	The command was unsuccessful.

Definition at line 56 of file Tpm2Session.c.

Tpm2Startup()

EFI_STATUS EFIAPI Tpm2Startup

(

IN TPM_SU

StartupType

)

Send Startup command to TPM2.

Parameters

[in]

StartupType

TPM_SU_CLEAR or TPM_SU_STATE

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 49 of file Tpm2Startup.c.

Tpm2TestParms()

EFI_STATUS EFIAPI Tpm2TestParms

(

IN TPMT_PUBLIC_PARMS *

Parameters

)

This command is used to check to see if specific combinations of algorithm parameters are supported.

Parameters

[in]

Parameters

Algorithm parameters to be validated

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_DEVICE_ERROR	Unexpected device behavior.

Definition at line 707 of file Tpm2Capability.c.