Go to file
Ryan Roberts 4f5ec5f731 docs: clarify instructions for running RME-enabled fw
This patch adds some documentation improvements in response to out-of-box
usability testing:

* Provide targetted links to other parts of the documentation.
* Clarify which toolchain is required.
* Clarify where the FVP binary and the bl1.bin and fip.bin files can be found
* Remove comment that cache state modelling is disabled in the known
  limitations, since it is now supported and enabled.

Signed-off-by: Soby Mathew <soby.mathew@arm.com>
Change-Id: I0b1d889c17edb5a40c4ed81c2a58c593258c3139
2021-09-02 10:55:55 +01:00
.husky build(hooks): add commitlint hook 2021-04-19 14:06:25 +01:00
bl1 fix: flush bl2_ep_info before exit from BL1 2021-07-27 11:28:33 +01:00
bl2 feat(RME): Run BL2 in root world 2021-06-10 22:12:19 -05:00
bl2u Avoid the use of linker *_SIZE__ macros 2021-04-21 15:05:57 +02:00
bl31 feat(RME): BL31 changes 2021-06-10 22:12:53 -05:00
bl32 feat(RME): Add TRP 2021-06-10 22:12:29 -05:00
common feat(fdt): introduce wrapper function to read DT UUIDs 2021-04-28 12:13:12 +01:00
docs docs: clarify instructions for running RME-enabled fw 2021-09-02 10:55:55 +01:00
drivers fix(driver/auth): avoid NV counter upgrade without certificate validation 2021-04-27 14:16:59 +01:00
fdts func(RME): Platform changes 2021-06-18 12:12:46 +01:00
include func(RME): Platform changes 2021-06-18 12:12:46 +01:00
lib feat(RME): BL31 changes 2021-06-10 22:12:53 -05:00
licenses docs(license): rectify `arm-gic.h` license 2021-04-26 12:36:00 +01:00
make_helpers feat(RME): Makefile changes to support ENABLE_RME build option 2021-06-18 12:12:46 +01:00
plat func(RME): Platform changes 2021-06-18 12:12:46 +01:00
services feat(RME): Add RMMD 2021-06-10 22:12:41 -05:00
tools fiptool: Do not call 'make clean' in 'all' target 2021-04-07 19:36:20 +02:00
.checkpatch.conf Re-apply GIT_COMMIT_ID check for checkpatch 2019-07-12 11:06:24 +01:00
.cz.json build(hooks): add Commitizen hook 2021-04-19 14:06:25 +01:00
.editorconfig .editorconfig: set max line length to 100 2020-12-03 15:39:23 +00:00
.gitignore build(hooks): add Husky configuration 2021-04-19 14:06:25 +01:00
.gitreview Specify integration as the default branch for git-review 2020-04-02 07:57:17 +00:00
Makefile feat(RME): Makefile changes to support ENABLE_RME build option 2021-06-18 12:12:46 +01:00
commitlint.config.js revert(commitlint): disable `signed-off-by` rule 2021-04-27 16:12:10 +01:00
dco.txt Drop requirement for CLA in contribution.md 2016-09-27 21:52:03 +01:00
license.rst doc: De-duplicate readme and license files 2019-10-08 16:36:15 +00:00
package-lock.json fix(hooks): downgrade `package-lock.json` version 2021-05-17 11:17:06 +01:00
package.json build(hooks): update Commitizen to ^4.2.4 2021-05-12 15:43:56 +01:00
readme.rst doc: Formatting fixes for readme.rst 2019-10-09 15:37:59 +00:00

readme.rst

Trusted Firmware-A
==================

Trusted Firmware-A (TF-A) is a reference implementation of secure world software
for `Arm A-Profile architectures`_ (Armv8-A and Armv7-A), including an Exception
Level 3 (EL3) `Secure Monitor`_. It provides a suitable starting point for
productization of secure world boot and runtime firmware, in either the AArch32
or AArch64 execution states.

TF-A implements Arm interface standards, including:

-  `Power State Coordination Interface (PSCI)`_
-  `Trusted Board Boot Requirements CLIENT (TBBR-CLIENT)`_
-  `SMC Calling Convention`_
-  `System Control and Management Interface (SCMI)`_
-  `Software Delegated Exception Interface (SDEI)`_

The code is designed to be portable and reusable across hardware platforms and
software models that are based on the Armv8-A and Armv7-A architectures.

In collaboration with interested parties, we will continue to enhance TF-A
with reference implementations of Arm standards to benefit developers working
with Armv7-A and Armv8-A TrustZone technology.

Users are encouraged to do their own security validation, including penetration
testing, on any secure world code derived from TF-A.

More Info and Documentation
---------------------------

To find out more about Trusted Firmware-A, please `view the full documentation`_
that is available through `trustedfirmware.org`_.

--------------

*Copyright (c) 2013-2019, Arm Limited and Contributors. All rights reserved.*

.. _Armv7-A and Armv8-A: https://developer.arm.com/products/architecture/a-profile
.. _Secure Monitor: http://www.arm.com/products/processors/technologies/trustzone/tee-smc.php
.. _Power State Coordination Interface (PSCI): PSCI_
.. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf
.. _Trusted Board Boot Requirements CLIENT (TBBR-CLIENT): https://developer.arm.com/docs/den0006/latest/trusted-board-boot-requirements-client-tbbr-client-armv8-a
.. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf
.. _System Control and Management Interface (SCMI): SCMI_
.. _SCMI: http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/DEN0056A_System_Control_and_Management_Interface.pdf
.. _Software Delegated Exception Interface (SDEI): SDEI_
.. _SDEI: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf
.. _Arm A-Profile architectures: https://developer.arm.com/architectures/cpu-architecture/a-profile
.. _view the full documentation: https://www.trustedfirmware.org/docs/tf-a
.. _trustedfirmware.org: http://www.trustedfirmware.org