TcgPpVendorLib.h File Reference

Go to the source code of this file.

Macros
#define	TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION   128
#define	TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_PROVISION   BIT0
#define	TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_CLEAR   BIT1
#define	TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_MAINTENANCE   BIT2
#define	TCG_VENDOR_LIB_FLAG_RESET_TRACK   BIT3
#define	TCG_PP_OPERATION_RESPONSE_SUCCESS   0x0
#define	TCG_PP_OPERATION_RESPONSE_USER_ABORT   0xFFFFFFF0
#define	TCG_PP_OPERATION_RESPONSE_BIOS_FAILURE   0xFFFFFFF1
#define	TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS   0
#define	TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED   1
#define	TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE   2
#define	TCG_PP_SUBMIT_REQUEST_TO_PREOS_BLOCKED_BY_BIOS_SETTINGS   3
#define	TCG_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED   0
#define	TCG_PP_GET_USER_CONFIRMATION_BIOS_ONLY   1
#define	TCG_PP_GET_USER_CONFIRMATION_BLOCKED_BY_BIOS_CONFIGURATION   2
#define	TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_REQUIRED   3
#define	TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_NOT_REQUIRED   4

Functions
UINT32 EFIAPI	TcgPpVendorLibExecutePendingRequest (IN UINT32 OperationRequest, IN OUT UINT32 *ManagementFlags, OUT BOOLEAN *ResetRequired)
BOOLEAN EFIAPI	TcgPpVendorLibHasValidRequest (IN UINT32 OperationRequest, IN UINT32 ManagementFlags, OUT BOOLEAN *RequestConfirmed)
UINT32 EFIAPI	TcgPpVendorLibSubmitRequestToPreOSFunction (IN UINT32 OperationRequest, IN UINT32 ManagementFlags)
UINT32 EFIAPI	TcgPpVendorLibGetUserConfirmationStatusFunction (IN UINT32 OperationRequest, IN UINT32 ManagementFlags)

Detailed Description

This library is to support TCG Physical Presence Interface (PPI) specification >= 128 Vendor Specific PPI Operation.

The Vendor Specific PPI operation may change TPM state, BIOS TPM management flags, and may need additional boot cycle.

Caution: This function may receive untrusted input.

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

Definition in file TcgPpVendorLib.h.

Macro Definition Documentation

TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_CLEAR

#define TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_CLEAR   BIT1

Definition at line 27 of file TcgPpVendorLib.h.

TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_MAINTENANCE

#define TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_MAINTENANCE   BIT2

Definition at line 28 of file TcgPpVendorLib.h.

TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_PROVISION

#define TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_PROVISION   BIT0

Definition at line 26 of file TcgPpVendorLib.h.

TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION

#define TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION   128

Definition at line 21 of file TcgPpVendorLib.h.

TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_NOT_REQUIRED

#define TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_NOT_REQUIRED   4

Definition at line 54 of file TcgPpVendorLib.h.

TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_REQUIRED

#define TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_REQUIRED   3

Definition at line 53 of file TcgPpVendorLib.h.

TCG_PP_GET_USER_CONFIRMATION_BIOS_ONLY

#define TCG_PP_GET_USER_CONFIRMATION_BIOS_ONLY   1

Definition at line 51 of file TcgPpVendorLib.h.

TCG_PP_GET_USER_CONFIRMATION_BLOCKED_BY_BIOS_CONFIGURATION

#define TCG_PP_GET_USER_CONFIRMATION_BLOCKED_BY_BIOS_CONFIGURATION   2

Definition at line 52 of file TcgPpVendorLib.h.

TCG_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED

#define TCG_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED   0

Definition at line 50 of file TcgPpVendorLib.h.

TCG_PP_OPERATION_RESPONSE_BIOS_FAILURE

#define TCG_PP_OPERATION_RESPONSE_BIOS_FAILURE   0xFFFFFFF1

Definition at line 36 of file TcgPpVendorLib.h.

TCG_PP_OPERATION_RESPONSE_SUCCESS

#define TCG_PP_OPERATION_RESPONSE_SUCCESS   0x0

Definition at line 34 of file TcgPpVendorLib.h.

TCG_PP_OPERATION_RESPONSE_USER_ABORT

#define TCG_PP_OPERATION_RESPONSE_USER_ABORT   0xFFFFFFF0

Definition at line 35 of file TcgPpVendorLib.h.

TCG_PP_SUBMIT_REQUEST_TO_PREOS_BLOCKED_BY_BIOS_SETTINGS

#define TCG_PP_SUBMIT_REQUEST_TO_PREOS_BLOCKED_BY_BIOS_SETTINGS   3

Definition at line 45 of file TcgPpVendorLib.h.

TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE

#define TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE   2

Definition at line 44 of file TcgPpVendorLib.h.

TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED

#define TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED   1

Definition at line 43 of file TcgPpVendorLib.h.

TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS

#define TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS   0

Definition at line 42 of file TcgPpVendorLib.h.

TCG_VENDOR_LIB_FLAG_RESET_TRACK

#define TCG_VENDOR_LIB_FLAG_RESET_TRACK   BIT3

Definition at line 29 of file TcgPpVendorLib.h.

Function Documentation

TcgPpVendorLibExecutePendingRequest()

UINT32 EFIAPI TcgPpVendorLibExecutePendingRequest	(	IN UINT32	OperationRequest,
		IN OUT UINT32 *	ManagementFlags,
		OUT BOOLEAN *	ResetRequired
	)

Check and execute the requested physical presence command.

This API should be invoked in BIOS boot phase to process pending request.

Caution: This function may receive untrusted input.

If OperationRequest < 128, then ASSERT().

Parameters

[in]	OperationRequest	TPM physical presence operation request.
[in,out]	ManagementFlags	BIOS TPM Management Flags.
[out]	ResetRequired	If reset is required to vendor settings in effect. True, it indicates the reset is required. False, it indicates the reset is not required.

Returns

TPM Operation Response to OS Environment.

Definition at line 31 of file TcgPpVendorLibNull.c.

TcgPpVendorLibGetUserConfirmationStatusFunction()

UINT32 EFIAPI TcgPpVendorLibGetUserConfirmationStatusFunction	(	IN UINT32	OperationRequest,
		IN UINT32	ManagementFlags
	)

The callback for TPM vendor specific physical presence which is called for Get User Confirmation Status for Operation.

This API should be invoked in OS runtime phase to interface with ACPI method.

Caution: This function may receive untrusted input.

If OperationRequest < 128, then ASSERT().

Parameters

[in]	OperationRequest	TPM physical presence operation request.
[in]	ManagementFlags	BIOS TPM Management Flags.

Returns

Return Code for Get User Confirmation Status for Operation.

Definition at line 116 of file TcgPpVendorLibNull.c.

TcgPpVendorLibHasValidRequest()

BOOLEAN EFIAPI TcgPpVendorLibHasValidRequest	(	IN UINT32	OperationRequest,
		IN UINT32	ManagementFlags,
		OUT BOOLEAN *	RequestConfirmed
	)

Check if there is a valid physical presence command request.

This API should be invoked in BIOS boot phase to process pending request.

Caution: This function may receive untrusted input.

If OperationRequest < 128, then ASSERT().

Parameters

[in]	OperationRequest	TPM physical presence operation request.
[in]	ManagementFlags	BIOS TPM Management Flags.
[out]	RequestConfirmed	If the physical presence operation command required user confirm from UI. True, it indicates the command doesn't require user confirm. False, it indicates the command need user confirm from UI.

Return values

TRUE	Physical Presence operation command is valid.
FALSE	Physical Presence operation command is invalid.

Definition at line 61 of file TcgPpVendorLibNull.c.

TcgPpVendorLibSubmitRequestToPreOSFunction()

UINT32 EFIAPI TcgPpVendorLibSubmitRequestToPreOSFunction	(	IN UINT32	OperationRequest,
		IN UINT32	ManagementFlags
	)

The callback for TPM vendor specific physical presence which is called for Submit TPM Operation Request to Pre-OS Environment and Submit TPM Operation Request to Pre-OS Environment 2.

This API should be invoked in OS runtime phase to interface with ACPI method.

Caution: This function may receive untrusted input.

If OperationRequest < 128, then ASSERT().

Parameters

[in]	OperationRequest	TPM physical presence operation request.
[in]	ManagementFlags	BIOS TPM Management Flags.

Returns

Return Code for Submit TPM Operation Request to Pre-OS Environment and Submit TPM Operation Request to Pre-OS Environment 2.

Definition at line 90 of file TcgPpVendorLibNull.c.