TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / rust-spmc / arm-ffa / ef6823579e58051c71d0569ec9e6d81cbc32d2d4
commitef6823579e58051c71d0569ec9e6d81cbc32d2d4[log] [tgz]
authorSandrine Afsa <sandrine.afsa@arm.com>Wed Jul 09 13:53:20 2025 +0200
committerSandrine Afsa <sandrine.afsa@arm.com>Wed Jul 09 14:08:51 2025 +0200
tree194bee4b160940250bab28b5c8668e0a6df962c4
parent0a3f7ca8ce07c9e66fb8bd37f491a273e0af9e59 [diff]
Apply Arm Trademark Guidance

This project uses Arm trademarks throughout source files, documentation
and tests. As per the Arm trademark guidance [1], the first use of each
of these trademarks must be preceded by the Arm word trademark.

This rule can be met by referring the user to the Arm Trademarks list on
the Arm website in the top level documentation, which in the case of this
project is the README.md file. This is considered to be "first use"
within the project as whole, with no necessity to adopt "First Use" form
within individual files throughout the source tree.

[1] https://www.arm.com/company/policies/trademarks/guidelines-trademarks
[2] https://www.arm.com/company/policies/trademarks/arm-trademark-list

Change-Id: Id021f4145451bcf3dcdea6df31ea66469a32f5ef
Signed-off-by: Sandrine Afsa <sandrine.afsa@arm.com>
1 file changed
tree: 194bee4b160940250bab28b5c8668e0a6df962c4
  1. .vscode/
  2. src/
  3. .gitignore
  4. Cargo.lock
  5. Cargo.toml
  6. CHANGELOG.md
  7. dco.txt
  8. LICENSE-APACHE
  9. LICENSE-MIT
  10. README.md
README.md

Arm Firmware Framework for Arm A-profile (FF-A) support library

Arm Firmware Framework for Arm A-profile (FF-A) specification

FF-A Memory Management Protocol specification

Library for handling common FF-A related functionality, create and parse interfaces and descriptors defined by FF-A. Starting from FF-A v1.2 the memory management related parts of the specification have been moved to a separate document (link above).

Design goals

  • Keep the code exception level agnostic by default. If exception level specific parts are inevitable, make it optional via a feature flag.
  • Keep the code no_std compatible. Use only core by default, make parts using alloc optional via a feature flag.
  • The interface towards the library's users should be ergonomic Rust and following Rust best-practices where possible.
    • Incorrect usage of this library when creating/packing/serializing data structures provided by this library is seen as a programmer error and the library will panic.
    • Parsing/unpacking/deserializing data structures provided by this library from a buffer is seen as runtime "user input data", and the library should make all necessary checks to validate the data. In this case the library should never panic, but return rich error types (preferably use thiserror) so the library user knows what's wrong.
  • The FF-A descriptors, packed structs and bit shifting magic should be private for the library, never exposed to the library user (i.e. ffa_v1_1 and later modules).
    • The implementation of such data structures should strictly follow the FF-A specification.
    • Preferably write a doc comment for each such definition that specifies where it comes from in the spec (i.e. Table x.y or chapter x.y.z)
    • The data structures should derive the necessary zerocopy traits.

FF-A version handling

The FF-A specification allows different components of a system to use different versions of the specification. The version used at a specific FF-A instance (i.e. an interface between two FF-A components) is discovered at runtime, either by parsing FF-A manifests or using FFA_VERSION. An FF-A component might have to use multiple versions at runtime on its different interfaces, therefore this library must be able to support this and having a compile time fixed version is not possible. Because of this, most of the functions to create or parse FF-A messages and data structures require passing the FF-A version used at the instance where the serialized data was received from or will be sent to.

Implemented features

  • Supports converting FF-A interface types between Rust types and the FF-A register ABI.
  • Memory transaction descriptor handling for FFA_MEM_* interfaces (partial).
  • FF-A v1.1+ boot information protocol.
  • FF-A partiton information descriptor.

Future plans

  • Implement missing features from FF-A v1.1 and later. Implementing FF-A v1.0 features that are deprecated by v1.1 are low priority for now.
  • Increase test coverage.
  • Create more detailed documentation to capture which parts of FF-A are currently supported.

License

The project is MIT and Apache-2.0 dual licensed, see LICENSE-APACHE and LICENSE-MIT.

Maintainers

arm-ffa is a trustedfirmware.org maintained project. All contributions are ultimately merged by the maintainers listed below.

Contributing

Please follow the directions of the Trusted Firmware Processes

Contributions are handled through review.trustedfirmware.org.

Arm trademark notice

Arm is a registered trademark of Arm Limited (or its subsidiaries or affiliates).

This project uses some of the Arm product, service or technology trademarks, as listed in the Trademark List, in accordance with the Arm Trademark Use Guidelines.

Subsequent uses of these trademarks throughout this repository do not need to be prefixed with the Arm word trademark.

Copyright 2025 Arm Limited and/or its affiliates open-source-office@arm.com