/** @file
Library that implements the helper functions to parse and pack a Transfer
List as specified by the A-profile Firmware Handoff Specification.
Copyright (c) 2022 - 2025, Arm Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Reference(s):
- https://github.com/FirmwareHandoff/firmware_handoff
**/
#include
#include
#include
#include
#include
#include
#include
typedef struct transfer_list_header LIBTL_TRANSFER_LIST_HEADER;
typedef struct transfer_list_entry LIBTL_TRANSFER_LIST_ENTRY;
STATIC_ASSERT (
sizeof (TRANSFER_LIST_HEADER) == sizeof (LIBTL_TRANSFER_LIST_HEADER),
"TRANSFER_LIST_HEADER size mismatch"
);
STATIC_ASSERT (
sizeof (TRANSFER_ENTRY_HEADER) == sizeof (LIBTL_TRANSFER_LIST_ENTRY),
"TRANSFER_ENTRY_HEADER size mismatch"
);
STATIC_ASSERT (
OFFSET_OF (TRANSFER_LIST_EVENTLOG, EventLog) == sizeof (UINT32),
"TRANSFER_LIST_EVENTLOG layout mismatch"
);
//
// TransferListCheckHeader() casts the libtl operation value directly to
// TRANSFER_LIST_OPS, so verify both enum definitions stay numerically aligned.
//
STATIC_ASSERT (
(UINT32)TL_OPS_NON == (UINT32)TRANSFER_LIST_OPS_INVALID,
"TL_OPS_NON mismatch"
);
STATIC_ASSERT (
(UINT32)TL_OPS_ALL == (UINT32)TRANSFER_LIST_OPS_ALL,
"TL_OPS_ALL mismatch"
);
STATIC_ASSERT (
(UINT32)TL_OPS_RO == (UINT32)TRANSFER_LIST_OPS_RO,
"TL_OPS_RO mismatch"
);
STATIC_ASSERT (
(UINT32)TL_OPS_CUS == (UINT32)TRANSFER_LIST_OPS_CUSTOM,
"TL_OPS_CUS mismatch"
);
/**
Convert a libtl transfer entry address to the public transfer entry type.
libtl marks the entry structure as packed for layout, while the transfer list
format keeps entries 8-byte aligned.
@param[in] Entry libtl entry address, or NULL.
@return Transfer entry header address, or NULL.
**/
STATIC
TRANSFER_ENTRY_HEADER *
LibtlEntryToTransferEntryHeader (
IN VOID *Entry
)
{
ASSERT ((Entry == NULL) || (((UINTN)Entry & (TRANSFER_LIST_ALIGNMENT - 1)) == 0));
return (TRANSFER_ENTRY_HEADER *)Entry;
}
/**
Get the TransferList from HOB list.
@param[out] TransferList TransferList
@retval EFI_SUCCESS TransferList is found.
@retval EFI_INVALID_PARAMETER TransferList is NULL.
@retval EFI_NOT_FOUND TransferList is not found.
**/
EFI_STATUS
EFIAPI
TransferListGetFromHobList (
OUT TRANSFER_LIST_HEADER **TransferList
)
{
VOID *HobList;
EFI_HOB_GUID_TYPE *GuidHob;
UINTN *GuidHobData;
if (TransferList == NULL) {
return EFI_INVALID_PARAMETER;
}
*TransferList = NULL;
HobList = GetHobList ();
if (HobList == NULL) {
return EFI_NOT_FOUND;
}
GuidHob = GetNextGuidHob (&gArmTransferListHobGuid, HobList);
if (GuidHob == NULL) {
return EFI_NOT_FOUND;
}
GuidHobData = GET_GUID_HOB_DATA (GuidHob);
*TransferList = (TRANSFER_LIST_HEADER *)(*GuidHobData);
return EFI_SUCCESS;
}
/**
This function verifies the checksum of the Transfer List.
@param [in] TransferListHeader Pointer to the Transfer List Header
@retval FALSE Invalid Checksum
@retval TRUE Valid Checksum
**/
BOOLEAN
EFIAPI
TransferListVerifyChecksum (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
return transfer_list_verify_checksum ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader);
}
/**
Check the Transfer List header and return an operation mode.
This function forwards to transfer_list_check_header() (libtl) and converts
the returned libtl operation code into the TRANSFER_LIST_OPS enum.
@param[in] TransferListHeader Pointer to the Transfer List header.
@retval TRANSFER_LIST_OPS_ALL Header is valid and usable (read/write).
@retval TRANSFER_LIST_OPS_RO Header is valid but only supports read-only
operations.
@retval TRANSFER_LIST_OPS_CUSTOM Header is valid but requires custom handling
due to a version mismatch.
@retval TRANSFER_LIST_OPS_INVALID Header is invalid or unsupported.
**/
TRANSFER_LIST_OPS
EFIAPI
TransferListCheckHeader (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
return (TRANSFER_LIST_OPS)transfer_list_check_header ((CONST LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader);
}
/**
Return the first Transfer Entry Node in the Transfer List.
@param [in] TransferListHeader TransferListHeader
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListGetFirstEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_next ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader, NULL)
);
}
/**
Return the next Transfer Entry Node in the Transfer List from
last Transfer Entry Node.
@param [in] TransferListHeader Pointer to the Transfer List Header.
@param [in] CurrentEntry Pointer to the Current Transfer Entry.
If this is NULL, the first Transfer Entry
is returned.
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListGetNextEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN TRANSFER_ENTRY_HEADER *CurrentEntry
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_next (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)CurrentEntry
)
);
}
/**
Return the first Transfer Entry Node in the Transfer List
matched with given tag-id.
@param [in] TransferListHeader Pointer to the Transfer List Header.
@param [in] TagId Tag id
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindFirstEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_find ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader, TagId)
);
}
/**
Return the Next Transfer Entry Node in the Transfer List
matched with given tag-id from last Transfer Entry Node.
@param [in] TransferListHeader Pointer to the Transfer List Header.
@param [in] CurrentEntry Pointer to the Current Transfer Entry.
If this is NULL, the first Transfer Entry
is returned.
@param [in] TagId Tag id
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindNextEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN TRANSFER_ENTRY_HEADER *CurrentEntry,
IN UINT32 TagId
)
{
TRANSFER_ENTRY_HEADER *Entry;
if (CurrentEntry == NULL) {
return TransferListFindFirstEntry (TransferListHeader, TagId);
} else {
Entry = TransferListGetNextEntry (TransferListHeader, CurrentEntry);
}
while ((Entry != NULL) && ((Entry->TagId & TRANSFER_LIST_TAGID_MASK) != (TagId & TRANSFER_LIST_TAGID_MASK))) {
Entry = TransferListGetNextEntry (TransferListHeader, Entry);
}
return Entry;
}
/**
Return the data in Transfer Entry.
@param [in] TransferEntry Pointer to a Transfer Entry Header
@return Pointer to the Data of Transfer Entry Node if successful otherwise NULL
**/
VOID *
EFIAPI
TransferListGetEntryData (
IN TRANSFER_ENTRY_HEADER *TransferEntry
)
{
if ((TransferEntry == NULL) || (TransferEntry->DataSize == 0)) {
return NULL;
}
return transfer_list_entry_data ((LIBTL_TRANSFER_LIST_ENTRY *)TransferEntry);
}
/**
Find a Transfer Entry Node in the Transfer List matched with the given tag-id.
@param [in] TransferListHeader Pointer to the Transfer List Header
@param [in] TagId Tag id
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId
)
{
TRANSFER_ENTRY_HEADER *Entry;
Entry = NULL;
do {
Entry = TransferListGetNextEntry (TransferListHeader, Entry);
} while ((Entry != NULL) && ((Entry->TagId & TRANSFER_LIST_TAGID_MASK) != (TagId & TRANSFER_LIST_TAGID_MASK)));
return Entry;
}
/**
Get TPM event log from the Transfer List.
@param [in] TransferListHeader Pointer to the Transfer List Header
@param [out] EventLog Pointer to the event log in TransferList
@param [out] EventLogSize Size of Event log
@param [out] EventLogFlags Flags for Event log
@return EFI_SUCCESS
@return EFI_NOT_FOUND No Event log in TransferListHeader
@return EFI_INVALID_PARAMETER Invalid parameters
**/
EFI_STATUS
EFIAPI
TransferListGetEventLog (
IN TRANSFER_LIST_HEADER *TransferListHeader,
OUT VOID **EventLog,
OUT UINTN *EventLogSize,
OUT UINT32 *EventLogFlags OPTIONAL
)
{
TRANSFER_ENTRY_HEADER *Entry;
TRANSFER_LIST_EVENTLOG *EntryData;
if ((TransferListHeader == NULL) || (EventLog == NULL) || (EventLogSize == NULL)) {
return EFI_INVALID_PARAMETER;
}
*EventLog = NULL;
*EventLogSize = 0;
Entry = TransferListFindFirstEntry (TransferListHeader, TRANSFER_ENTRY_TAG_ID_TPM_EVENT_LOG);
if ((Entry == NULL) || (Entry->DataSize == 0) ||
((Entry->DataSize - OFFSET_OF (TRANSFER_LIST_EVENTLOG, EventLog)) == 0))
{
return EFI_NOT_FOUND;
}
EntryData = TransferListGetEntryData (Entry);
if (EventLogFlags != NULL) {
*EventLogFlags = EntryData->Flags;
}
*EventLogSize = Entry->DataSize - OFFSET_OF (TRANSFER_LIST_EVENTLOG, EventLog);
*EventLog = (VOID *)&EntryData->EventLog;
return EFI_SUCCESS;
}
/**
Dump the transfer list to the debug output.
@param [in] TransferListHeader Pointer to the Transfer List Header
**/
VOID
EFIAPI
TransferListDump (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
TRANSFER_ENTRY_HEADER *Entry;
UINTN Idx;
Entry = NULL;
Idx = 0;
if (TransferListHeader == NULL) {
return;
}
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Dump transfer list:\n"));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "signature 0x%x\n", TransferListHeader->Signature));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "checksum 0x%x\n", TransferListHeader->Checksum));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "version 0x%x\n", TransferListHeader->Version));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "hdr_size 0x%x\n", TransferListHeader->HeaderSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "alignment 0x%x\n", TransferListHeader->Alignment));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "used_size 0x%x\n", TransferListHeader->UsedSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "total_size 0x%x\n", TransferListHeader->TotalSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "flags 0x%x\n", TransferListHeader->Flags));
while (TRUE) {
Entry = TransferListGetNextEntry (TransferListHeader, Entry);
if (Entry == NULL) {
break;
}
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Entry %d:\n", Idx++));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "tag_id 0x%x\n", Entry->TagId));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "hdr_size 0x%x\n", Entry->HeaderSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "data_size 0x%x\n", Entry->DataSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "data_addr 0x%lx\n", (UINTN)TransferListGetEntryData (Entry)));
}
}
/**
Ensure a valid Transfer List exists at the specified buffer; initialize
if the buffer does not have a valid TL header.
@param[in,out] TransferListBase Base address of the buffer/region.
@param[in] TransferListCapacity Total capacity (bytes) of the buffer.
@return Pointer to the Transfer List header on success; NULL on failure.
**/
TRANSFER_LIST_HEADER *
EFIAPI
TransferListEnsure (
IN OUT VOID *TransferListBase,
IN UINTN TransferListCapacity
)
{
return (TRANSFER_LIST_HEADER *)transfer_list_ensure (TransferListBase, (size_t)TransferListCapacity);
}
/**
Relocate an existing Transfer List to a new buffer with the given capacity.
Useful when the Transfer List must grow beyond its current region (e.g., when
backed by a fixed flash window).
@param[in] TransferListHeader Pointer to the current Transfer List header.
@param[out] DestinationBase Destination buffer address.
@param[in] DestinationCapacity Capacity in bytes of the destination buffer.
@return Pointer to the relocated Transfer List header; NULL on failure.
**/
TRANSFER_LIST_HEADER *
EFIAPI
TransferListRelocate (
IN TRANSFER_LIST_HEADER *TransferListHeader,
OUT VOID *DestinationBase,
IN UINTN DestinationCapacity
)
{
return (TRANSFER_LIST_HEADER *)transfer_list_relocate (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
DestinationBase,
(size_t)DestinationCapacity
);
}
/**
Append a new Transfer Entry.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full (up to 24-bit) tag identifier.
@param[in] DataSize Payload size in bytes.
@param[in] Data Optional source buffer (may be NULL).
@retval NULL Append failed (e.g., insufficient capacity).
@retval non-NULL Pointer to the newly added entry.
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListAdd (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId,
IN UINT32 DataSize,
IN CONST VOID *Data OPTIONAL
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_add (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
TagId,
DataSize,
Data
)
);
}
/**
Resize an existing Transfer Entry payload.
On growth, subsequent entries may be moved to make room. On shrink, space is
reclaimed. Call TransferListUpdateChecksum() after modifications.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in,out] Entry Entry to resize.
@param[in] NewDataSize New payload size in bytes.
@retval TRUE Resize succeeded; Entry remains valid.
@retval FALSE Resize failed (e.g., insufficient capacity).
**/
BOOLEAN
EFIAPI
TransferListSetDataSize (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN OUT TRANSFER_ENTRY_HEADER *Entry,
IN UINT32 NewDataSize
)
{
return transfer_list_set_data_size (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)Entry,
NewDataSize
) ? TRUE : FALSE;
}
/**
Remove a Transfer Entry.
After removal, the Transfer List is compacted as required by the underlying
implementation. Call TransferListUpdateChecksum() if not done automatically.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in,out] Entry Entry to remove.
@retval TRUE Entry removed.
@retval FALSE Removal failed.
**/
BOOLEAN
EFIAPI
TransferListRemove (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN OUT TRANSFER_ENTRY_HEADER *Entry
)
{
return transfer_list_rem (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)Entry
) ? TRUE : FALSE;
}
/**
Optional reverse iterator: return the previous entry.
@param[in] TransferListHeader TL header.
@param[in] CurrentEntry Current entry.
@retval NULL No previous entry.
@retval non-NULL Previous entry.
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListGetPrevEntry (
TRANSFER_LIST_HEADER *TransferListHeader,
TRANSFER_ENTRY_HEADER *CurrentEntry
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_prev (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)CurrentEntry
)
);
}
/**
Find the first Transfer Entry whose full TagId (up to 24 bits) matches.
This is a thin wrapper over the underlying implementation. It returns the
first matching entry, or NULL if no match exists.
@param[in] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full tag identifier to match.
@retval NULL No matching entry or TransferListHeader is NULL.
@retval non-NULL Pointer to the first matching entry.
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindEntryByTag (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_find ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader, TagId)
);
}
/**
Read the first entry matching the full TagId (up to 24-bit).
@param[in] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full tag identifier to match.
@param[out] EntryOut On success, receives the entry pointer.
@param[out] EntryDataOut Optional; receives pointer to entry data.
@param[out] EntryDataSizeOut Optional; receives data size in bytes.
@retval EFI_SUCCESS Match found and output parameters set.
@retval EFI_NOT_FOUND No entry with TagId.
@retval EFI_INVALID_PARAMETER TransferListHeader or EntryOut is NULL.
**/
EFI_STATUS
EFIAPI
TransferListReadEntryByTag (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId,
OUT TRANSFER_ENTRY_HEADER **EntryOut,
OUT VOID **EntryDataOut OPTIONAL,
OUT UINT32 *EntryDataSizeOut OPTIONAL
)
{
TRANSFER_ENTRY_HEADER *Entry;
if ((TransferListHeader == NULL) || (EntryOut == NULL)) {
return EFI_INVALID_PARAMETER;
}
Entry = TransferListFindEntryByTag (TransferListHeader, TagId);
if (Entry == NULL) {
return EFI_NOT_FOUND;
}
*EntryOut = Entry;
if (EntryDataOut != NULL) {
*EntryDataOut = TransferListGetEntryData (Entry);
}
if (EntryDataSizeOut != NULL) {
*EntryDataSizeOut = Entry->DataSize;
}
return EFI_SUCCESS;
}
/**
Update (or create) an entry by TagId.
If an entry with TagId exists, it is resized if needed and the payload is
overwritten with Data (if Data is not NULL). If no entry exists and
CreateIfMissing is TRUE, a new entry is appended (aligned to Alignment if
non-zero). The Transfer List checksum is updated on success.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full tag identifier to update.
@param[in] Data Source buffer (may be NULL to only resize).
@param[in] DataSize Size of Data in bytes.
@param[in] CreateIfMissing If TRUE, create the entry when missing.
@param[in] AlignmentLog2 Optional power-of-two alignment (0 to use default).
@retval EFI_SUCCESS Entry updated or created.
@retval EFI_NOT_FOUND Entry not found and CreateIfMissing is FALSE.
@retval EFI_BUFFER_TOO_SMALL Not enough capacity to add/resize.
@retval EFI_INVALID_PARAMETER TransferListHeader is NULL.
**/
EFI_STATUS
EFIAPI
TransferListUpdateEntryByTag (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId,
IN CONST VOID *Data OPTIONAL,
IN UINT32 DataSize,
IN BOOLEAN CreateIfMissing,
IN UINT8 AlignmentLog2
)
{
TRANSFER_ENTRY_HEADER *Entry;
VOID *EntryData;
if (TransferListHeader == NULL) {
return EFI_INVALID_PARAMETER;
}
Entry = TransferListFindEntryByTag (TransferListHeader, TagId);
if (Entry == NULL) {
if (!CreateIfMissing) {
return EFI_NOT_FOUND;
}
if (AlignmentLog2 != 0) {
Entry = LibtlEntryToTransferEntryHeader (
transfer_list_add_with_align (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
TagId,
DataSize,
NULL,
AlignmentLog2
)
);
} else {
Entry = LibtlEntryToTransferEntryHeader (
transfer_list_add (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
TagId,
DataSize,
NULL
)
);
}
if (Entry == NULL) {
return EFI_BUFFER_TOO_SMALL;
}
} else if (Entry->DataSize != DataSize) {
if (!(transfer_list_set_data_size (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)Entry,
DataSize
))
)
{
return EFI_BUFFER_TOO_SMALL;
}
}
if ((Data != NULL) && (DataSize != 0)) {
EntryData = transfer_list_entry_data ((LIBTL_TRANSFER_LIST_ENTRY *)Entry);
CopyMem (EntryData, Data, DataSize);
}
transfer_list_update_checksum ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader);
return EFI_SUCCESS;
}