aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSummer Qin <summer.qin@arm.com>2021-04-08 16:31:27 +0800
committerKen Liu <ken.liu@arm.com>2021-05-06 05:18:47 +0200
commita1f68964a4f6f155b88b9cd662327f386db67bc3 (patch)
treeabb37431983cbe60df1f6e709679fd47afdf5e0a
parent1098de81ff7df8dad9b30f3280725247c1019930 (diff)
downloadtrusted-firmware-m-a1f68964a4f6f155b88b9cd662327f386db67bc3.tar.gz
Docs: Refine introduction
Refine the content of introduction. Move 'releases' and 'platform supported' into their separate directory. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: Ia791ae8114401966a9512fb0d12f98068b1b775e
-rw-r--r--docs/introduction/readme.rst112
-rw-r--r--docs/releases/index.rst35
-rw-r--r--platform/ext/index.rst15
-rw-r--r--platform/ext/platform_introduction.rst58
4 files changed, 113 insertions, 107 deletions
diff --git a/docs/introduction/readme.rst b/docs/introduction/readme.rst
index c86889da1..c90f8ceb1 100644
--- a/docs/introduction/readme.rst
+++ b/docs/introduction/readme.rst
@@ -4,9 +4,9 @@ Trusted Firmware M
Trusted Firmware-M (TF-M) implements the Secure Processing Environment (SPE)
for Armv8-M, Armv8.1-M architectures (e.g. the `Cortex-M33`_, `Cortex-M23`_,
-`Cortex-M55`_ processors) or dual-core platforms.It is the platform security
-architecture reference implementation aligning with PSA Certified guidelines,
-enabling chips,Real Time Operating Systems and devices to become PSA Certified.
+`Cortex-M55`_ processors) and dual-core platforms. It is the platform security
+architecture reference implementation aligning with PSA Certified guidelines,
+enabling chips, Real Time Operating Systems and devices to become PSA Certified.
TF-M relies on an isolation boundary between the Non-secure Processing
Environment (NSPE) and the Secure Processing Environment (SPE). It can but is
@@ -59,15 +59,6 @@ folders. The original license text is included in those source files.
- The ``platform`` folder currently contains platforms support imported from
the external project and the files may have different licenses.
-#########################
-Release Notes and Process
-#########################
-The :doc:`Release Cadence and Process </docs/releases/release_process>` provides
-release cadence and process information.
-
-The :doc:`Releases </docs/releases/index>` provides details of
-major features of the release and platforms supported.
-
###############
Getting Started
###############
@@ -85,9 +76,9 @@ good understanding of the v8-M architecture is also necessary. A good place to
get started with ARMv8-M is
`developer.arm.com <https://developer.arm.com/architectures/cpu-architecture/m-profile>`__.
-**********************
-Really getting started
-**********************
+**************************
+Build and run instructions
+**************************
Trusted Firmware M source code is available on
`git.trustedfirmware.org <https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/>`__.
@@ -104,66 +95,22 @@ To build & run TF-M:
To port TF-M to a another system or OS, follow the
:doc:`OS Integration Guide </docs/integration_guide/tfm_integration_guide>`
-Please also see the :doc:`glossary </docs/glossary>` of terms used in the project.
-
:doc:`Contributing Guidelines </docs/contributing/contributing_process>` contains guidance on how to
contribute to this project.
-Further documents can be found in the ``docs`` folder.
-
###################
Platforms supported
###################
- - Cortex-M55 system:
-
- - `FPGA image loaded on MPS3 board (AN547).
- <https://developer.arm.com/products/system-design/development-boards/cortex-m-prototyping-systems/mps3>`_
- - `Fast model FVP_SSE300_MPS2.
- <https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps>`_
-
- - Cortex-M33 system:
-
- - `FPGA image loaded on MPS2 board (AN521).
- <https://developer.arm.com/products/system-design/development-boards/cortex-m-prototyping-systems/mps2>`_
- - `Fast model FVP_MPS2_AEMv8M (AN521).
- <https://developer.arm.com/products/system-design/fixed-virtual-platforms>`_
- - `Musca-B1 test chip board.
- <https://developer.arm.com/products/system-design/development-boards/iot-test-chips-and-boards/musca-b-test-chip-board>`_
- - `Musca-S1 test chip board.
- <https://developer.arm.com/tools-and-software/development-boards/iot-test-chips-and-boards/musca-s1-test-chip-board>`_
- - `FPGA image loaded on MPS3 board (AN524).
- <https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/mps3>`_
- - `LPC55S69.
- <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc5500-cortex-m33/lpcxpresso55s69-development-board:LPC55S69-EVK>`_
- - `NUCLEO L552ZE Q.
- <https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-nucleo-boards/nucleo-l552ze-q.html>`_
- - `DISCO L562QE.
- <https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-discovery-kits/stm32l562e-dk.html>`_
- - `nRF9160 DK (nordic_nrf/nrf9160dk_nrf9160).
- <https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF9160-DK>`_
- - `nRF5340 DK (nordic_nrf/nrf5340dk_nrf5340_cpuapp).
- <https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF5340-DK>`_
- - `BL5340 DVK (lairdconnectivity/bl5340_dvk_cpuapp).
- <https://www.lairdconnect.com/wireless-modules/bluetooth-modules/bluetooth-5-modules/bl5340-series-multi-core-bluetooth-52-802154-nfc-modules>`_
-
- - Cortex-M23 system:
-
- - `FPGA image loaded on MPS2 board (AN519).
- <https://developer.arm.com/products/system-design/development-boards/cortex-m-prototyping-systems/mps2>`_
- - `M2351.
- <https://www.nuvoton.com/products/iot-solution/iot-platform/numaker-pfm-m2351/>`_
-
- - Dual Core Cortex-M system:
-
- - `PSoc64.
- <https://www.cypress.com/documentation/product-brochures/cypress-psoc-64-secure-microcontrollers>`_
-
- - Secure Enclave system:
-
- - :doc:`Musca-B1 Secure Enclave. </platform/ext/target/musca_b1/secure_enclave/readme>`
-
-The document :doc:`Platform Deprecation and Removal </platform/ext/platform_deprecation>`
-lists the deprecated platforms planned to be removed from upstream.
+The document :doc:`Supported Platforms </platform/ext/index>` lists the details.
+
+#########################
+Release Notes and Process
+#########################
+The :doc:`Release Cadence and Process </docs/releases/release_process>` provides
+release cadence and process information.
+
+The :doc:`Releases </docs/releases/index>` provides details of
+major features of the release and platforms supported.
####################
Feedback and support
@@ -171,33 +118,6 @@ Feedback and support
For this release, feedback is requested via email to
`tf-m@lists.trustedfirmware.org <tf-m@lists.trustedfirmware.org>`__.
-###############
-Version history
-###############
-+-------------+--------------+--------------------+-------------------+
-| Version | Date | Description | PSA-arch tag/hash |
-+=============+==============+====================+===================+
-| v1.0-beta | 2019-02-15 | 1.0-beta release | - |
-+-------------+--------------+--------------------+-------------------+
-| v1.0-RC1 | 2019-05-31 | 1.0-RC1 release | v19.06_API0.9 |
-+-------------+--------------+--------------------+-------------------+
-| v1.0-RC2 | 2019-10-09 | 1.0-RC2 release | v19.06_API0.9 |
-+-------------+--------------+--------------------+-------------------+
-| v1.0-RC3 | 2019-11-29 | 1.0-RC3 release | v19.06_API0.9 |
-+-------------+--------------+--------------------+-------------------+
-| v1.0 | 2020-03-27 | 1.0 release | v20.03_API1.0 |
-+-------------+--------------+--------------------+-------------------+
-| v1.1 | 2020-07-15 | 1.1 release | 1f960947 |
-+-------------+--------------+--------------------+-------------------+
-| v1.2.0 | 2020-11-25 | 1.2.0 release | 90c8e680 |
-+-------------+--------------+--------------------+-------------------+
-| v1.3.0 | 2021-04-07 | 1.3.0 release | b0635d9 |
-+-------------+--------------+--------------------+-------------------+
-
-Please refer to
-:ref:`docs/releases/release_process:Release Version Scheme` for interpreting
-version numbers.
-
.. _Cortex-M33: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m33
.. _Cortex-M23: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m23
.. _Cortex-M55: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m55
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
index dc8aecbcd..125888537 100644
--- a/docs/releases/index.rst
+++ b/docs/releases/index.rst
@@ -2,11 +2,38 @@ Releases
========
.. toctree::
- :maxdepth: 1
- :glob:
+ :hidden:
- *
+ 1.0
+ 1.1
+ 1.2.0
+ 1.3.0
+ release_process
+
++--------------------------------------+--------------+--------------------+-------------------+
+| Version | Date | Description | PSA-arch tag/hash |
++======================================+==============+====================+===================+
+| v1.0-beta | 2019-02-15 | 1.0-beta release | |
++--------------------------------------+--------------+--------------------+-------------------+
+| v1.0-RC1 | 2019-05-31 | 1.0-RC1 release | v19.06_API0.9 |
++--------------------------------------+--------------+--------------------+-------------------+
+| v1.0-RC2 | 2019-10-09 | 1.0-RC2 release | v19.06_API0.9 |
++--------------------------------------+--------------+--------------------+-------------------+
+| v1.0-RC3 | 2019-11-29 | 1.0-RC3 release | v19.06_API0.9 |
++--------------------------------------+--------------+--------------------+-------------------+
+| :doc:`v1.0 </docs/releases/1.0>` | 2020-03-27 | 1.0 release | v20.03_API1.0 |
++--------------------------------------+--------------+--------------------+-------------------+
+| :doc:`v1.1 </docs/releases/1.1>` | 2020-07-15 | 1.1 release | 1f960947 |
++--------------------------------------+--------------+--------------------+-------------------+
+| :doc:`v1.2.0 </docs/releases/1.2.0>` | 2020-11-25 | 1.2.0 release | 90c8e680 |
++--------------------------------------+--------------+--------------------+-------------------+
+| :doc:`v1.3.0 </docs/releases/1.3.0>` | 2021-04-07 | 1.3.0 release | b0635d9 |
++--------------------------------------+--------------+--------------------+-------------------+
+
+Please refer to
+:ref:`docs/releases/release_process:Release Cadence and Process` for
+interpreting version numbers.
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/platform/ext/index.rst b/platform/ext/index.rst
index 7fa6b74f0..3c3e8d176 100644
--- a/platform/ext/index.rst
+++ b/platform/ext/index.rst
@@ -7,10 +7,11 @@ Supported Platforms
/platform/readme
readme
+ /platform/ext/platform_introduction.rst
/platform/ext/platform_deprecation.rst
.. toctree::
- :maxdepth: 4
+ :maxdepth: 1
:caption: arm
:glob:
@@ -19,42 +20,42 @@ Supported Platforms
otp_provisioning.rst
.. toctree::
- :maxdepth: 4
+ :maxdepth: 1
:caption: NXP
:glob:
target/nxp/**
.. toctree::
- :maxdepth: 4
+ :maxdepth: 1
:caption: Cypress
:glob:
target/cypress/**
.. toctree::
- :maxdepth: 4
+ :maxdepth: 1
:caption: STM
:glob:
target/stm/index
.. toctree::
- :maxdepth: 4
+ :maxdepth: 1
:caption: Nordic
:glob:
target/nordic_nrf/**
.. toctree::
- :maxdepth: 4
+ :maxdepth: 1
:caption: Laird Connectivity
:glob:
target/lairdconnectivity/**
.. toctree::
- :maxdepth: 4
+ :maxdepth: 1
:caption: Nuvoton
:glob:
diff --git a/platform/ext/platform_introduction.rst b/platform/ext/platform_introduction.rst
new file mode 100644
index 000000000..6bf10640b
--- /dev/null
+++ b/platform/ext/platform_introduction.rst
@@ -0,0 +1,58 @@
+######################
+Platforms introduction
+######################
+
+ - Cortex-M55 system:
+
+ - `FPGA image loaded on MPS3 board (AN547).
+ <https://developer.arm.com/products/system-design/development-boards/cortex-m-prototyping-systems/mps3>`_
+ - `Fast model FVP_SSE300_MPS2.
+ <https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps>`_
+
+ - Cortex-M33 system:
+
+ - `FPGA image loaded on MPS2 board (AN521).
+ <https://developer.arm.com/products/system-design/development-boards/cortex-m-prototyping-systems/mps2>`_
+ - `Fast model FVP_MPS2_AEMv8M (AN521).
+ <https://developer.arm.com/products/system-design/fixed-virtual-platforms>`_
+ - `Musca-B1 test chip board.
+ <https://developer.arm.com/products/system-design/development-boards/iot-test-chips-and-boards/musca-b-test-chip-board>`_
+ - `Musca-S1 test chip board.
+ <https://developer.arm.com/tools-and-software/development-boards/iot-test-chips-and-boards/musca-s1-test-chip-board>`_
+ - `FPGA image loaded on MPS3 board (AN524).
+ <https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/mps3>`_
+ - `LPC55S69.
+ <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc5500-cortex-m33/lpcxpresso55s69-development-board:LPC55S69-EVK>`_
+ - `NUCLEO L552ZE Q.
+ <https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-nucleo-boards/nucleo-l552ze-q.html>`_
+ - `DISCO L562QE.
+ <https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-discovery-kits/stm32l562e-dk.html>`_
+ - `nRF9160 DK (nordic_nrf/nrf9160dk_nrf9160).
+ <https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF9160-DK>`_
+ - `nRF5340 DK (nordic_nrf/nrf5340dk_nrf5340_cpuapp).
+ <https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF5340-DK>`_
+ - `BL5340 DVK (lairdconnectivity/bl5340_dvk_cpuapp).
+ <https://www.lairdconnect.com/wireless-modules/bluetooth-modules/bluetooth-5-modules/bl5340-series-multi-core-bluetooth-52-802154-nfc-modules>`_
+
+ - Cortex-M23 system:
+
+ - `FPGA image loaded on MPS2 board (AN519).
+ <https://developer.arm.com/products/system-design/development-boards/cortex-m-prototyping-systems/mps2>`_
+ - `M2351.
+ <https://www.nuvoton.com/products/iot-solution/iot-platform/numaker-pfm-m2351/>`_
+
+ - Dual Core Cortex-M system:
+
+ - `PSoc64.
+ <https://www.cypress.com/documentation/product-brochures/cypress-psoc-64-secure-microcontrollers>`_
+
+ - Secure Enclave system:
+
+ - :doc:`Musca-B1 Secure Enclave. </platform/ext/target/musca_b1/secure_enclave/readme>`
+
+The document :doc:`Platform Deprecation and Removal </platform/ext/platform_deprecation>`
+lists the deprecated platforms planned to be removed from upstream.
+
+--------------
+
+*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*