TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / shared / transfer-list-library / b01ab96fcd42f057252634b019c07c0dcb8c921a
commitb01ab96fcd42f057252634b019c07c0dcb8c921a[log] [tgz]
authorHarrison Mutai <harrison.mutai@arm.com>Thu May 01 10:17:58 2025 +0000
committerHarrison Mutai <harrison.mutai@arm.com>Fri Jun 13 13:52:54 2025 +0000
tree39bfb444f545b1d53c036c60a771098bb330d512
parent789db583c6bd1a83f41ecf8efc8468f76769b106 [diff]
refactor: improve documentation for APIs in code

Documents public transfer list APIs with detailed Doxygen-style
comments. This should makes the make the interface into the library more
transparent.

Change-Id: I7e6e6f0d81d92333ca47fb7b669e1067dcabed9b
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
3 files changed
tree: 39bfb444f545b1d53c036c60a771098bb330d512
  1. cmake/
  2. include/
  3. src/
  4. test/
  5. tlc/
  6. toolchains/
  7. .clang-format
  8. .gitignore
  9. CMakeLists.txt
  10. CONTRIBUTING.md
  11. LICENSE-GPL-2.0-or-later.md
  12. LICENSE-MIT.md
  13. LICENSE.md
  14. Makefile.tll
  15. README.md
README.md

Transfer List Library (LibTL)

The Transfer List Library (LibTL) implements the Firmware Handoff specification, providing a streamlined interface for managing transfer lists. LibTL offers a user-friendly interface for:

  • Creating transfer lists
  • Reading and extracting data from transfer lists
  • Manipulating and updating transfer lists

The library supports building with host tools such as Clang and GCC, and cross compilation with the Aarch64 GNU compiler.

Minimum Supporting Tooling Requirements

ToolMinimum Version
Clang-Format14
CMake3.15

Building with CMake

To configure the project, use the following command. This will default to using GCC as the toolchain and create a build directory named build/:

cmake -B build

To build the project, use:

cmake --build build

This will output libtl.a in the build directory.

For cross-compilation or selecting a different compiler, specify the target toolchain file using the CMAKE_TOOLCHAIN_FILE option and the target with CROSS_COMPILE:

export CROSS_COMPILE=aarch64-none-elf-
cmake -B build -DCMAKE_TOOLCHAIN_FILE=toolchains/host/gnu.cmake

Testing with CTest

Tests for LibTL are provided in the folder test, to configure the project for test builds, run:

cmake -B build -DTARGET_GROUP=test
cmake --build build

Then, to run the tests with ctest, use:

ctest --test-dir build/