Include dependency graph for TrEEProtocol.h:
Go to the source code of this file.
Classes | |
| struct | _TREE_VERSION |
| struct | _TREE_BOOT_SERVICE_CAPABILITY |
| struct | TrEE_EVENT_HEADER |
| struct | TrEE_EVENT |
| struct | _EFI_TREE_PROTOCOL |
Macros | |
| #define | EFI_TREE_PROTOCOL_GUID {0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f} |
| #define | TREE_EVENT_LOG_FORMAT_TCG_1_2 0x00000001 |
| #define | TREE_BOOT_HASH_ALG_SHA1 0x00000001 |
| #define | TREE_BOOT_HASH_ALG_SHA256 0x00000002 |
| #define | TREE_BOOT_HASH_ALG_SHA384 0x00000004 |
| #define | TREE_BOOT_HASH_ALG_SHA512 0x00000008 |
| #define | TREE_EXTEND_ONLY 0x0000000000000001 |
| #define | PE_COFF_IMAGE 0x0000000000000010 |
| #define | MAX_PCR_INDEX 23 |
| #define | TREE_EVENT_HEADER_VERSION 1 |
Variables | |
| EFI_GUID | gEfiTrEEProtocolGuid |
Detailed Description
This protocol is defined to abstract TPM2 hardware access in boot phase.
Copyright (c) 2013 - 2018, 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.
Macro Definition Documentation
◆ EFI_TREE_PROTOCOL_GUID
| #define EFI_TREE_PROTOCOL_GUID {0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f} |
◆ MAX_PCR_INDEX
| #define MAX_PCR_INDEX 23 |
◆ PE_COFF_IMAGE
| #define PE_COFF_IMAGE 0x0000000000000010 |
◆ TREE_BOOT_HASH_ALG_SHA1
| #define TREE_BOOT_HASH_ALG_SHA1 0x00000001 |
◆ TREE_BOOT_HASH_ALG_SHA256
| #define TREE_BOOT_HASH_ALG_SHA256 0x00000002 |
◆ TREE_BOOT_HASH_ALG_SHA384
| #define TREE_BOOT_HASH_ALG_SHA384 0x00000004 |
◆ TREE_BOOT_HASH_ALG_SHA512
| #define TREE_BOOT_HASH_ALG_SHA512 0x00000008 |
◆ TREE_EVENT_HEADER_VERSION
| #define TREE_EVENT_HEADER_VERSION 1 |
◆ TREE_EVENT_LOG_FORMAT_TCG_1_2
| #define TREE_EVENT_LOG_FORMAT_TCG_1_2 0x00000001 |
◆ TREE_EXTEND_ONLY
| #define TREE_EXTEND_ONLY 0x0000000000000001 |
Typedef Documentation
◆ EFI_TREE_GET_CAPABILITY
| typedef EFI_STATUS(EFIAPI * EFI_TREE_GET_CAPABILITY) (IN EFI_TREE_PROTOCOL *This, IN OUT TREE_BOOT_SERVICE_CAPABILITY *ProtocolCapability) |
The EFI_TREE_PROTOCOL GetCapability function call provides protocol capability information and state information about the TrEE.
- Parameters
-
[in] This Indicates the calling context [out] ProtocolCapability The caller allocates memory for a TREE_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 TrEE 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).
◆ EFI_TREE_GET_EVENT_LOG
| typedef EFI_STATUS(EFIAPI * EFI_TREE_GET_EVENT_LOG) (IN EFI_TREE_PROTOCOL *This, IN TREE_EVENT_LOG_FORMAT EventLogFormat, OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, OUT BOOLEAN *EventLogTruncated) |
The EFI_TREE_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).
◆ EFI_TREE_HASH_LOG_EXTEND_EVENT
| typedef EFI_STATUS(EFIAPI * EFI_TREE_HASH_LOG_EXTEND_EVENT) (IN EFI_TREE_PROTOCOL *This, IN UINT64 Flags, IN EFI_PHYSICAL_ADDRESS DataToHash, IN UINT64 DataToHashLen, IN TrEE_EVENT *Event) |
The EFI_TREE_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] Event 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.
◆ EFI_TREE_PROTOCOL
| typedef struct _EFI_TREE_PROTOCOL EFI_TREE_PROTOCOL |
◆ EFI_TREE_SUBMIT_COMMAND
| typedef EFI_STATUS(EFIAPI * EFI_TREE_SUBMIT_COMMAND) (IN EFI_TREE_PROTOCOL *This, IN UINT32 InputParameterBlockSize, IN UINT8 *InputParameterBlock, IN UINT32 OutputParameterBlockSize, IN UINT8 *OutputParameterBlock) |
This service enables the sending of commands to the TrEE.
- Parameters
-
[in] This Indicates the calling context [in] InputParameterBlockSize Size of the TrEE input parameter block. [in] InputParameterBlock Pointer to the TrEE input parameter block. [in] OutputParameterBlockSize Size of the TrEE output parameter block. [in] OutputParameterBlock Pointer to the TrEE 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.
◆ TREE_BOOT_SERVICE_CAPABILITY
◆ TREE_BOOT_SERVICE_CAPABILITY_1_0
| typedef struct _TREE_BOOT_SERVICE_CAPABILITY TREE_BOOT_SERVICE_CAPABILITY_1_0 |
◆ TREE_EVENT_LOG_BITMAP
| typedef UINT32 TREE_EVENT_LOG_BITMAP |
◆ TREE_EVENT_LOG_FORMAT
| typedef UINT32 TREE_EVENT_LOG_FORMAT |
◆ TrEE_EVENTTYPE
| typedef UINT32 TrEE_EVENTTYPE |
◆ TrEE_PCRINDEX
| typedef UINT32 TrEE_PCRINDEX |
◆ TREE_VERSION
| typedef struct _TREE_VERSION TREE_VERSION |
Variable Documentation
◆ gEfiTrEEProtocolGuid
|
extern |
