andrius
/
arm-trusted-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #1750 from pbeesley-arm/pb/readme-updates 

doc: Minor reword & reformatting in readme.rst
This commit is contained in:
Antonio Niño Díaz 2019-01-15 09:50:30 +00:00 committed by GitHub
parent 63b9b5425f d1ce4469a3
commit 532beaec46
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
readme.rst
View File

@ -9,7 +9,7 @@ such as:
- The `Power State Coordination Interface (PSCI)`_ - The `Power State Coordination Interface (PSCI)`_
- Trusted Board Boot Requirements (TBBR, Arm DEN0006C-1) - Trusted Board Boot Requirements (TBBR, Arm DEN0006C-1)
- `SMC Calling Convention`_ - `SMC Calling Convention`_
- `System Control and Management Interface`_ - `System Control and Management Interface (SCMI)`_
- `Software Delegated Exception Interface (SDEI)`_ - `Software Delegated Exception Interface (SDEI)`_
Where possible, the code is designed for reuse or porting to other Armv7-A and Where possible, the code is designed for reuse or porting to other Armv7-A and
@ -58,7 +58,7 @@ This release
This release provides a suitable starting point for productization of secure This release provides a suitable starting point for productization of secure
world boot and runtime firmware, in either the AArch32 or AArch64 execution world boot and runtime firmware, in either the AArch32 or AArch64 execution
state. states.
Users are encouraged to do their own security validation, including penetration Users are encouraged to do their own security validation, including penetration
testing, on any secure world code derived from TF-A. testing, on any secure world code derived from TF-A.
@ -95,13 +95,13 @@ Functionality
- Secure Monitor library code such as world switching, EL1 context management - Secure Monitor library code such as world switching, EL1 context management
and interrupt routing. and interrupt routing.
When a Secure-EL1 Payload (SP) is present, for example a Secure OS, the When a Secure-EL1 Payload (SP) is present, for example a Secure OS, the
AArch64 EL3 Runtime Software must be integrated with a dispatcher component AArch64 EL3 Runtime Software must be integrated with a Secure Payload
(SPD) to customize the interaction with the SP. Dispatcher (SPD) component to customize the interaction with the SP.
- A Test SP/SPD to demonstrate AArch64 Secure Monitor functionality and SP - A Test SP and SPD to demonstrate AArch64 Secure Monitor functionality and SP
interaction with PSCI. interaction with PSCI.
- SPDs for the `OP-TEE Secure OS`_, `NVidia Trusted Little Kernel`_ - SPDs for the `OP-TEE Secure OS`_, `NVIDIA Trusted Little Kernel`_
and `Trusty Secure OS`_. and `Trusty Secure OS`_.
- A Trusted Board Boot implementation, conforming to all mandatory TBBR - A Trusted Board Boot implementation, conforming to all mandatory TBBR
@ -136,8 +136,8 @@ Functionality
- Support for the GCC, LLVM and Arm Compiler 6 toolchains. - Support for the GCC, LLVM and Arm Compiler 6 toolchains.
- Support combining several libraries into a self-called "romlib" image, that - Support for combining several libraries into a self-called "romlib" image
may be shared across images to reduce memory footprint. The romlib image that may be shared across images to reduce memory footprint. The romlib image
is stored in ROM but is accessed through a jump-table that may be stored is stored in ROM but is accessed through a jump-table that may be stored
in read-write memory, allowing for the library code to be patched. in read-write memory, allowing for the library code to be patched.
@ -148,8 +148,8 @@ provides details of changes made since the last release.
Platforms Platforms
~~~~~~~~~ ~~~~~~~~~
Various AArch32 and AArch64 builds of this release has been tested on variants Various AArch32 and AArch64 builds of this release have been tested on r0, r1
r0, r1 and r2 of the `Juno Arm Development Platform`_. and r2 variants of the `Juno Arm Development Platform`_.
Various AArch64 builds of this release have been tested on the following Arm Various AArch64 builds of this release have been tested on the following Arm
Fixed Virtual Platforms (`FVP`_) without shifted affinities that do not Fixed Virtual Platforms (`FVP`_) without shifted affinities that do not
@ -229,10 +229,10 @@ Getting started
Get the TF-A source code from `GitHub`_. Get the TF-A source code from `GitHub`_.
See the `User Guide`_ for instructions on how to install, build and use See the `User Guide`_ for instructions on how to install, build and use TF-A
the TF-A with the Arm `FVP`_\ s. with the Arm `FVP`_\ s.
See the `Firmware Design`_ for information on how the TF-A works. See the `Firmware Design`_ for information on how TF-A works.
See the `Porting Guide`_ as well for information about how to use this See the `Porting Guide`_ as well for information about how to use this
software on another Armv7-A or Armv8-A platform. software on another Armv7-A or Armv8-A platform.
@ -267,7 +267,7 @@ Arm licensees may contact Arm directly via their partner managers.
.. _Power State Coordination Interface (PSCI): PSCI_ .. _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 .. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf
.. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf .. _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_ .. _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 .. _SCMI: http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/DEN0056A_System_Control_and_Management_Interface.pdf
.. _Software Delegated Exception Interface (SDEI): SDEI_ .. _Software Delegated Exception Interface (SDEI): SDEI_
.. _SDEI: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf .. _SDEI: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf
@ -276,7 +276,7 @@ Arm licensees may contact Arm directly via their partner managers.
.. _FVP: https://developer.arm.com/products/system-design/fixed-virtual-platforms .. _FVP: https://developer.arm.com/products/system-design/fixed-virtual-platforms
.. _Linaro Release 18.04: https://community.arm.com/dev-platforms/b/documents/posts/linaro-release-notes-deprecated#LinaroRelease18.04 .. _Linaro Release 18.04: https://community.arm.com/dev-platforms/b/documents/posts/linaro-release-notes-deprecated#LinaroRelease18.04
.. _OP-TEE Secure OS: https://github.com/OP-TEE/optee_os .. _OP-TEE Secure OS: https://github.com/OP-TEE/optee_os
.. _NVidia Trusted Little Kernel: http://nv-tegra.nvidia.com/gitweb/?p=3rdparty/ote_partner/tlk.git;a=summary .. _NVIDIA Trusted Little Kernel: http://nv-tegra.nvidia.com/gitweb/?p=3rdparty/ote_partner/tlk.git;a=summary
.. _Trusty Secure OS: https://source.android.com/security/trusty .. _Trusty Secure OS: https://source.android.com/security/trusty
.. _GitHub: https://www.github.com/ARM-software/arm-trusted-firmware .. _GitHub: https://www.github.com/ARM-software/arm-trusted-firmware
.. _GitHub issue tracker: https://github.com/ARM-software/tf-issues/issues .. _GitHub issue tracker: https://github.com/ARM-software/tf-issues/issues