SecurityPkg/Include/Library/TrEEPpVendorLib.h File Reference


Defines

#define TREE_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION   128
#define TREE_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_CLEAR   BIT1
#define TREE_VENDOR_LIB_FLAG_RESET_TRACK   BIT3
#define TREE_PP_OPERATION_RESPONSE_SUCCESS   0x0
#define TREE_PP_OPERATION_RESPONSE_USER_ABORT   0xFFFFFFF0
#define TREE_PP_OPERATION_RESPONSE_BIOS_FAILURE   0xFFFFFFF1
#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS   0
#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED   1
#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE   2
#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_BLOCKED_BY_BIOS_SETTINGS   3
#define TREE_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED   0
#define TREE_PP_GET_USER_CONFIRMATION_BIOS_ONLY   1
#define TREE_PP_GET_USER_CONFIRMATION_BLOCKED_BY_BIOS_CONFIGURATION   2
#define TREE_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_REQUIRED   3
#define TREE_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_NOT_REQUIRED   4

Functions

UINT32 EFIAPI TrEEPpVendorLibExecutePendingRequest (IN TPM2B_AUTH *PlatformAuth, IN UINT32 OperationRequest, IN OUT UINT32 *ManagementFlags, OUT BOOLEAN *ResetRequired)
BOOLEAN EFIAPI TrEEPpVendorLibHasValidRequest (IN UINT32 OperationRequest, IN UINT32 ManagementFlags, OUT BOOLEAN *RequestConfirmed)
UINT32 EFIAPI TrEEPpVendorLibSubmitRequestToPreOSFunction (IN UINT32 OperationRequest, IN UINT32 ManagementFlags)
UINT32 EFIAPI TrEEPpVendorLibGetUserConfirmationStatusFunction (IN UINT32 OperationRequest, IN UINT32 ManagementFlags)

Detailed Description

Ihis library is to support Trusted Execution Environment (TrEE) ACPI Profile >= 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, 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 TREE_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_CLEAR   BIT1

#define TREE_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION   128

#define TREE_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_NOT_REQUIRED   4

#define TREE_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_REQUIRED   3

#define TREE_PP_GET_USER_CONFIRMATION_BIOS_ONLY   1

#define TREE_PP_GET_USER_CONFIRMATION_BLOCKED_BY_BIOS_CONFIGURATION   2

#define TREE_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED   0

#define TREE_PP_OPERATION_RESPONSE_BIOS_FAILURE   0xFFFFFFF1

#define TREE_PP_OPERATION_RESPONSE_SUCCESS   0x0

#define TREE_PP_OPERATION_RESPONSE_USER_ABORT   0xFFFFFFF0

#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_BLOCKED_BY_BIOS_SETTINGS   3

#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE   2

#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED   1

#define TREE_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS   0

#define TREE_VENDOR_LIB_FLAG_RESET_TRACK   BIT3


Function Documentation

UINT32 EFIAPI TrEEPpVendorLibExecutePendingRequest ( IN TPM2B_AUTH *  PlatformAuth,
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] PlatformAuth platform auth value. NULL means no platform auth change.
[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.

References TREE_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION, and TREE_PP_OPERATION_RESPONSE_BIOS_FAILURE.

Referenced by TrEEExecutePendingTpmRequest().

UINT32 EFIAPI TrEEPpVendorLibGetUserConfirmationStatusFunction ( 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.

References TREE_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION, and TREE_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED.

Referenced by PhysicalPresenceCallback().

BOOLEAN EFIAPI TrEEPpVendorLibHasValidRequest ( 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.

References TREE_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION.

Referenced by TrEEHaveValidTpmRequest().

UINT32 EFIAPI TrEEPpVendorLibSubmitRequestToPreOSFunction ( 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.

References TREE_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION, and TREE_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED.

Referenced by PhysicalPresenceCallback().


Generated on Thu Sep 24 23:44:24 2015 for SecurityPkg[ALL] by  doxygen 1.5.7.1