TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / shared / transfer-list-library / 2886e1501b2dfcd881bae4962ec7de35baa31922
commit2886e1501b2dfcd881bae4962ec7de35baa31922[log] [tgz]
authorHarrison Mutai <harrison.mutai@arm.com>Wed May 14 15:38:47 2025 +0000
committerHarrison Mutai <harrison.mutai@arm.com>Fri Jun 13 13:52:56 2025 +0000
tree2a2cb5391f4728f405b3a754a9596d74b719a6bd
parentb01ab96fcd42f057252634b019c07c0dcb8c921a [diff]
docs: clarify build and cross-compilation instructions

Improve documentation for configuring and building the project with
CMake. Explain how to use the CC and CMAKE_BUILD_TYPE options. Clarify
the purpose of PROJECT_API.

Change-Id: I457a97593e86c392e8cc7b1caf595f6fd5bfa4c5
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
1 file changed
tree: 2a2cb5391f4728f405b3a754a9596d74b719a6bd
  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 with the default settings (using GCC as the host compiler), run:

cmake -B build

Then, to compile the project and produce libtl.a in the build/ directory:

cmake --build build

To cross-compile the project (e.g., for AArch64), specify the appropriate tool using the CC option when configuring the project:

CC=aarch64-none-elf-gcc cmake -B build -DCMAKE_TRY_COMPILE_TARGET_TYPE=STATIC_LIBRARY
cmake --build build

You can specify the build mode using the CMAKE_BUILD_TYPE option. Supported modes include:

  • Debug – Full debug info with no optimization.
  • Release – Optimized build without debug info.
  • RelWithDebInfo – Optimized build with debug info.
  • MinSizeRel – Optimized for minimum size.

APIs for specific projects can be conditionally included in the static library using the PROJECT_API option.

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/