TcgEventLogRecordLib.h File Reference

#include <Uefi.h>

Go to the source code of this file.

Data Structures
struct	PLATFORM_FIRMWARE_BLOB2_STRUCT
struct	HANDOFF_TABLE_POINTERS2_STRUCT

Macros
#define	PLATFORM_FIRMWARE_BLOB_DESC   "Fv(XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
#define	HANDOFF_TABLE_POINTER_DESC   "1234567890ABCDEF"

Functions
VOID *	TpmMeasurementGetFvName (IN EFI_PHYSICAL_ADDRESS FvBase, IN UINT64 FvLength)
EFI_STATUS EFIAPI	MeasureFirmwareBlob (IN UINT32 PcrIndex, IN CHAR8 *Description OPTIONAL, IN EFI_PHYSICAL_ADDRESS FirmwareBlobBase, IN UINT64 FirmwareBlobLength)
EFI_STATUS EFIAPI	MeasureHandoffTable (IN UINT32 PcrIndex, IN CHAR8 *Description OPTIONAL, IN EFI_GUID *TableGuid, IN VOID *TableAddress, IN UINTN TableLength)

Detailed Description

This library is used by other modules to measure Firmware to TPM.

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

Definition in file TcgEventLogRecordLib.h.

Macro Definition Documentation

HANDOFF_TABLE_POINTER_DESC

#define HANDOFF_TABLE_POINTER_DESC   "1234567890ABCDEF"

Definition at line 24 of file TcgEventLogRecordLib.h.

PLATFORM_FIRMWARE_BLOB_DESC

#define PLATFORM_FIRMWARE_BLOB_DESC   "Fv(XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"

Definition at line 16 of file TcgEventLogRecordLib.h.

Function Documentation

MeasureFirmwareBlob()

EFI_STATUS EFIAPI MeasureFirmwareBlob	(	IN UINT32	PcrIndex,
		IN CHAR8 *Description	OPTIONAL,
		IN EFI_PHYSICAL_ADDRESS	FirmwareBlobBase,
		IN UINT64	FirmwareBlobLength
	)

Measure a FirmwareBlob.

Parameters

[in]	PcrIndex	PCR Index.
[in]	Description	Description for this FirmwareBlob.
[in]	FirmwareBlobBase	Base address of this FirmwareBlob.
[in]	FirmwareBlobLength	Size in bytes of this FirmwareBlob.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_UNSUPPORTED	TPM device not available.
EFI_OUT_OF_RESOURCES	Out of memory.
EFI_DEVICE_ERROR	The operation was unsuccessful.

Measure a FirmwareBlob.

Parameters

[in]	PcrIndex	PcrIndex of the measurement.
[in]	Description	Description for this FirmwareBlob.
[in]	FirmwareBlobBase	Base address of this FirmwareBlob.
[in]	FirmwareBlobLength	Size in bytes of this FirmwareBlob.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_UNSUPPORTED	TPM device not available.
EFI_OUT_OF_RESOURCES	Out of memory.
EFI_DEVICE_ERROR	The operation was unsuccessful.

Definition at line 87 of file TcgEventLogRecordLib.c.

MeasureHandoffTable()

EFI_STATUS EFIAPI MeasureHandoffTable	(	IN UINT32	PcrIndex,
		IN CHAR8 *Description	OPTIONAL,
		IN EFI_GUID *	TableGuid,
		IN VOID *	TableAddress,
		IN UINTN	TableLength
	)

Measure a HandoffTable.

Parameters

[in]	PcrIndex	PcrIndex of the measurement.
[in]	Description	Description for this HandoffTable.
[in]	TableGuid	GUID of this HandoffTable.
[in]	TableAddress	Base address of this HandoffTable.
[in]	TableLength	Size in bytes of this HandoffTable.

Return values

EFI_SUCCESS	Operation completed successfully.
EFI_UNSUPPORTED	TPM device not available.
EFI_OUT_OF_RESOURCES	Out of memory.
EFI_DEVICE_ERROR	The operation was unsuccessful.

Definition at line 157 of file TcgEventLogRecordLib.c.

TpmMeasurementGetFvName()

VOID * TpmMeasurementGetFvName	(	IN EFI_PHYSICAL_ADDRESS	FvBase,
		IN UINT64	FvLength
	)

Get the FvName from the FV header.

Causion: The FV is untrusted input.

Parameters

[in]	FvBase	Base address of FV image.
[in]	FvLength	Length of FV image.

Returns

FvName pointer

Return values

NULL	FvName is NOT found

Definition at line 34 of file TcgEventLogRecordLib.c.