mirror of https://github.com/acidanthera/audk.git
114 lines
3.6 KiB
C
114 lines
3.6 KiB
C
/** @file
|
|
This library abstract how to access TPM2 hardware device.
|
|
|
|
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef _TPM2_DEVICE_LIB_H_
|
|
#define _TPM2_DEVICE_LIB_H_
|
|
|
|
#include <Uefi.h>
|
|
|
|
//
|
|
// Used in PcdActiveTpmInterfaceType to identify TPM interface type
|
|
//
|
|
typedef enum {
|
|
Tpm2PtpInterfaceTis,
|
|
Tpm2PtpInterfaceFifo,
|
|
Tpm2PtpInterfaceCrb,
|
|
Tpm2PtpInterfaceMax,
|
|
} TPM2_PTP_INTERFACE_TYPE;
|
|
|
|
/**
|
|
This service enables the sending of commands to the TPM2.
|
|
|
|
@param[in] InputParameterBlockSize Size of the TPM2 input parameter block.
|
|
@param[in] InputParameterBlock Pointer to the TPM2 input parameter block.
|
|
@param[in,out] OutputParameterBlockSize Size of the TPM2 output parameter block.
|
|
@param[in] OutputParameterBlock Pointer to the TPM2 output parameter block.
|
|
|
|
@retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.
|
|
@retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.
|
|
@retval EFI_BUFFER_TOO_SMALL The output parameter block is too small.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Tpm2SubmitCommand (
|
|
IN UINT32 InputParameterBlockSize,
|
|
IN UINT8 *InputParameterBlock,
|
|
IN OUT UINT32 *OutputParameterBlockSize,
|
|
IN UINT8 *OutputParameterBlock
|
|
);
|
|
|
|
/**
|
|
This service requests use TPM2.
|
|
|
|
@retval EFI_SUCCESS Get the control of TPM2 chip.
|
|
@retval EFI_NOT_FOUND TPM2 not found.
|
|
@retval EFI_DEVICE_ERROR Unexpected device behavior.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Tpm2RequestUseTpm (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This service enables the sending of commands to the TPM2.
|
|
|
|
@param[in] InputParameterBlockSize Size of the TPM2 input parameter block.
|
|
@param[in] InputParameterBlock Pointer to the TPM2 input parameter block.
|
|
@param[in,out] OutputParameterBlockSize Size of the TPM2 output parameter block.
|
|
@param[in] OutputParameterBlock Pointer to the TPM2 output parameter block.
|
|
|
|
@retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.
|
|
@retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.
|
|
@retval EFI_BUFFER_TOO_SMALL The output parameter block is too small.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *TPM2_SUBMIT_COMMAND)(
|
|
IN UINT32 InputParameterBlockSize,
|
|
IN UINT8 *InputParameterBlock,
|
|
IN OUT UINT32 *OutputParameterBlockSize,
|
|
IN UINT8 *OutputParameterBlock
|
|
);
|
|
|
|
/**
|
|
This service requests use TPM2.
|
|
|
|
@retval EFI_SUCCESS Get the control of TPM2 chip.
|
|
@retval EFI_NOT_FOUND TPM2 not found.
|
|
@retval EFI_DEVICE_ERROR Unexpected device behavior.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *TPM2_REQUEST_USE_TPM)(
|
|
VOID
|
|
);
|
|
|
|
typedef struct {
|
|
EFI_GUID ProviderGuid;
|
|
TPM2_SUBMIT_COMMAND Tpm2SubmitCommand;
|
|
TPM2_REQUEST_USE_TPM Tpm2RequestUseTpm;
|
|
} TPM2_DEVICE_INTERFACE;
|
|
|
|
/**
|
|
This service register TPM2 device.
|
|
|
|
@param Tpm2Device TPM2 device
|
|
|
|
@retval EFI_SUCCESS This TPM2 device is registered successfully.
|
|
@retval EFI_UNSUPPORTED System does not support register this TPM2 device.
|
|
@retval EFI_ALREADY_STARTED System already register this TPM2 device.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Tpm2RegisterTpm2DeviceLib (
|
|
IN TPM2_DEVICE_INTERFACE *Tpm2Device
|
|
);
|
|
|
|
#endif
|