mirror of
https://github.com/CTCaer/switch-l4t-atf.git
synced 2024-12-01 05:40:27 +00:00
8cc36aec91
The readme.rst and license.rst files in the project root overlap with the index.rst and license.rst files in the docs/ folder. We need to use the latter when building the documentation, as Sphinx requires all included files to be under a common root. However, the files in the root are currently used by the cgit and Github viewers. Using symlinks in Git presents some difficulties so the best course of action is likely to leave these files but in stub form. The license.rst file in the root will simply tell the reader to refer to docs/license.rst. The readme.rst file will contain a small amount of content that is derived from the docs/index.rst file, so that the Github main page will have something valid to show, but it will also contain a link to the full documentation on ReadTheDocs. Change-Id: I6dc46f08777e8d7ecb32ca7afc07a28486c9f77a Signed-off-by: Paul Beesley <paul.beesley@arm.com>
52 lines
2.6 KiB
ReStructuredText
52 lines
2.6 KiB
ReStructuredText
Trusted Firmware-A
|
|
==================
|
|
|
|
Trusted Firmware-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.
|
|
|
|
Read More
|
|
---------
|
|
|
|
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
|
|
|