aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSummer Qin <summer.qin@arm.com>2021-04-06 17:22:15 +0800
committerSummer Qin <summer.qin@arm.com>2021-04-21 10:34:53 +0800
commitabf6698dd6b916de5aea971783aa80776bf296dd (patch)
tree7e1727767491c52d7bce438d2bf88c89fb05da78
parentcdaec9c383182052b8535b74e92a4799b98236cd (diff)
downloadtrusted-firmware-m-abf6698dd6b916de5aea971783aa80776bf296dd.tar.gz
Docs: Restructure the documents
Restructure the file category to let it more friendly to users. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I7ced0e2d700ce03423e472e0098608f3445ba169
-rw-r--r--docs/contributing/code_review_guide.rst6
-rw-r--r--docs/contributing/coding_guide.rst4
-rw-r--r--docs/contributing/contributing_process.rst (renamed from docs/contributing/contributing.rst)6
-rw-r--r--docs/contributing/doc_guidelines.rst6
-rw-r--r--docs/contributing/index.rst8
-rw-r--r--docs/contributing/maintainers.rst4
-rw-r--r--docs/contributing/tfm_design_proposal_process.rst10
-rw-r--r--docs/getting_started/index.rst9
-rw-r--r--docs/getting_started/tfm_build_instruction.rst4
-rw-r--r--docs/getting_started/tfm_user_guide.rst8
-rw-r--r--docs/glossary.rst (renamed from docs/reference/glossary.rst)0
-rw-r--r--docs/index.rst58
-rw-r--r--docs/integration_guide/index.rst12
-rw-r--r--docs/integration_guide/os_migration_guide_armv8m.rst (renamed from docs/getting_started/os_migration_guide_armv8m.rst)6
-rw-r--r--docs/integration_guide/services/core_test_services_integration_guide.rst (renamed from docs/reference/services/core_test_services_integration_guide.rst)0
-rw-r--r--docs/integration_guide/services/index.rst (renamed from docs/reference/services/index.rst)0
-rw-r--r--docs/integration_guide/services/tfm_attestation_integration_guide.rst (renamed from docs/reference/services/tfm_attestation_integration_guide.rst)0
-rw-r--r--docs/integration_guide/services/tfm_audit_integration_guide.rst (renamed from docs/reference/services/tfm_audit_integration_guide.rst)0
-rw-r--r--docs/integration_guide/services/tfm_crypto_integration_guide.rst (renamed from docs/reference/services/tfm_crypto_integration_guide.rst)0
-rw-r--r--docs/integration_guide/services/tfm_its_integration_guide.rst (renamed from docs/reference/services/tfm_its_integration_guide.rst)0
-rw-r--r--docs/integration_guide/services/tfm_platform_integration_guide.rst (renamed from docs/reference/services/tfm_platform_integration_guide.rst)0
-rw-r--r--docs/integration_guide/services/tfm_ps_integration_guide.rst (renamed from docs/reference/services/tfm_ps_integration_guide.rst)6
-rw-r--r--docs/integration_guide/services/tfm_psa_proxy_integration_guide.rst (renamed from docs/reference/services/tfm_psa_proxy_integration_guide.rst)4
-rw-r--r--docs/integration_guide/services/tfm_secure_partition_addition.rst (renamed from docs/reference/services/tfm_secure_partition_addition.rst)0
-rw-r--r--docs/integration_guide/tfm_integration_guide.rst (renamed from docs/getting_started/tfm_integration_guide.rst)8
-rw-r--r--docs/introduction/index.rst3
-rw-r--r--docs/introduction/readme.rst20
-rw-r--r--docs/reference/changelog.rst15
-rw-r--r--docs/reference/index.rst16
-rw-r--r--docs/releases/1.0.rst (renamed from docs/reference/releases/1.0.rst)0
-rw-r--r--docs/releases/1.1.rst (renamed from docs/reference/releases/1.1.rst)0
-rw-r--r--docs/releases/1.2.0.rst (renamed from docs/reference/releases/1.2.0.rst)6
-rw-r--r--docs/releases/1.3.0.rst (renamed from docs/reference/releases/1.3.0.rst)16
-rw-r--r--docs/releases/index.rst (renamed from docs/reference/releases/index.rst)0
-rw-r--r--docs/releases/release_process.rst (renamed from docs/contributing/release_process.rst)0
-rw-r--r--docs/security/index.rst12
-rw-r--r--docs/security/security.rst (renamed from docs/reference/security.rst)6
-rw-r--r--docs/security/security_advisories/index.rst (renamed from docs/reference/security_advisories/index.rst)0
-rw-r--r--docs/security/security_advisories/stack_seal_vulnerability.rst (renamed from docs/reference/security_advisories/stack_seal_vulnerability.rst)0
-rw-r--r--docs/security/security_advisories/svc_caller_sp_fetching_vulnerability.rst (renamed from docs/reference/security_advisories/svc_caller_sp_fetching_vulnerability.rst)0
-rw-r--r--docs/security/threat_models/TF-M-block-diagram.png (renamed from docs/threat_models/TF-M-block-diagram.png)bin124526 -> 124526 bytes
-rw-r--r--docs/security/threat_models/generic_threat_model.rst (renamed from docs/threat_models/generic_threat_model.rst)10
-rw-r--r--docs/security/threat_models/index.rst (renamed from docs/threat_models/index.rst)0
-rw-r--r--docs/security/threat_models/overall-DFD.png (renamed from docs/threat_models/overall-DFD.png)bin17954 -> 17954 bytes
-rw-r--r--docs/technical_references/code_sharing.rst (renamed from docs/design_documents/code_sharing.rst)0
-rw-r--r--docs/technical_references/dual-cpu/booting_a_dual_core_system.rst (renamed from docs/design_documents/dual-cpu/booting_a_dual_core_system.rst)0
-rw-r--r--docs/technical_references/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst (renamed from docs/design_documents/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst)0
-rw-r--r--docs/technical_references/dual-cpu/dual_core_mailbox_arch.png (renamed from docs/design_documents/dual-cpu/dual_core_mailbox_arch.png)bin31782 -> 31782 bytes
-rw-r--r--docs/technical_references/dual-cpu/index.rst (renamed from docs/design_documents/dual-cpu/index.rst)0
-rw-r--r--docs/technical_references/dual-cpu/mailbox_design_on_dual_core_system.rst (renamed from docs/design_documents/dual-cpu/mailbox_design_on_dual_core_system.rst)0
-rw-r--r--docs/technical_references/dual-cpu/tfm_multi_core_access_check.rst (renamed from docs/design_documents/dual-cpu/tfm_multi_core_access_check.rst)0
-rw-r--r--docs/technical_references/enum_implicit_casting.rst (renamed from docs/design_documents/enum_implicit_casting.rst)0
-rw-r--r--docs/technical_references/ff_isolation.rst (renamed from docs/design_documents/ff_isolation.rst)4
-rw-r--r--docs/technical_references/hardware_abstraction_layer.rst (renamed from docs/design_documents/hardware_abstraction_layer.rst)2
-rw-r--r--docs/technical_references/index.rst (renamed from docs/design_documents/index.rst)4
-rw-r--r--docs/technical_references/index.rst.in (renamed from docs/design_documents/index.rst.in)0
-rw-r--r--docs/technical_references/media/hal_structure.png (renamed from docs/design_documents/media/hal_structure.png)bin32736 -> 32736 bytes
-rw-r--r--docs/technical_references/media/symmetric_initial_attest/attest_token_finish.png (renamed from docs/design_documents/media/symmetric_initial_attest/attest_token_finish.png)bin14947 -> 14947 bytes
-rw-r--r--docs/technical_references/media/symmetric_initial_attest/attest_token_start.png (renamed from docs/design_documents/media/symmetric_initial_attest/attest_token_start.png)bin30230 -> 30230 bytes
-rw-r--r--docs/technical_references/media/symmetric_initial_attest/ia_service_flow.png (renamed from docs/design_documents/media/symmetric_initial_attest/ia_service_flow.png)bin50354 -> 50354 bytes
-rw-r--r--docs/technical_references/media/symmetric_initial_attest/iat_decode.png (renamed from docs/design_documents/media/symmetric_initial_attest/iat_decode.png)bin40309 -> 40309 bytes
-rw-r--r--docs/technical_references/media/symmetric_initial_attest/overall_diagram.png (renamed from docs/design_documents/media/symmetric_initial_attest/overall_diagram.png)bin14536 -> 14536 bytes
-rw-r--r--docs/technical_references/media/tfm_crypto_design.png (renamed from docs/design_documents/media/tfm_crypto_design.png)bin32529 -> 32529 bytes
-rw-r--r--docs/technical_references/profiles/index.rst (renamed from docs/design_documents/profiles/index.rst)0
-rw-r--r--docs/technical_references/profiles/tfm_profile_large.rst (renamed from docs/design_documents/profiles/tfm_profile_large.rst)10
-rw-r--r--docs/technical_references/profiles/tfm_profile_medium.rst (renamed from docs/design_documents/profiles/tfm_profile_medium.rst)8
-rw-r--r--docs/technical_references/profiles/tfm_profile_small.rst (renamed from docs/design_documents/profiles/tfm_profile_small.rst)8
-rw-r--r--docs/technical_references/ps_key_management.rst (renamed from docs/design_documents/ps_key_management.rst)0
-rw-r--r--docs/technical_references/secure_boot_hw_key_integration.rst (renamed from docs/design_documents/secure_boot_hw_key_integration.rst)0
-rw-r--r--docs/technical_references/secure_boot_rollback_protection.rst (renamed from docs/design_documents/secure_boot_rollback_protection.rst)0
-rw-r--r--docs/technical_references/secure_enclave_solution.rst (renamed from docs/design_documents/secure_enclave_solution.rst)0
-rw-r--r--docs/technical_references/source_structure.rst (renamed from docs/design_documents/source_structure.rst)4
-rw-r--r--docs/technical_references/symmetric_initial_attest.rst (renamed from docs/design_documents/symmetric_initial_attest.rst)6
-rw-r--r--docs/technical_references/tfm_code_generation_with_jinja2.rst (renamed from docs/design_documents/tfm_code_generation_with_jinja2.rst)0
-rw-r--r--docs/technical_references/tfm_cooperative_scheduling_rules.rst (renamed from docs/design_documents/tfm_cooperative_scheduling_rules.rst)0
-rw-r--r--docs/technical_references/tfm_crypto_design.rst (renamed from docs/design_documents/tfm_crypto_design.rst)0
-rw-r--r--docs/technical_references/tfm_fwu_service.rst (renamed from docs/design_documents/tfm_fwu_service.rst)0
-rw-r--r--docs/technical_references/tfm_its_512_flash.rst (renamed from docs/design_documents/tfm_its_512_flash.rst)0
-rw-r--r--docs/technical_references/tfm_its_service.rst (renamed from docs/design_documents/tfm_its_service.rst)0
-rw-r--r--docs/technical_references/tfm_log_system_design_document.rst (renamed from docs/design_documents/tfm_log_system_design_document.rst)0
-rw-r--r--docs/technical_references/tfm_non-secure_interrupt_handling.rst (renamed from docs/design_documents/tfm_non-secure_interrupt_handling.rst)0
-rw-r--r--docs/technical_references/tfm_non_secure_client_management.rst (renamed from docs/design_documents/tfm_non_secure_client_management.rst)0
-rw-r--r--docs/technical_references/tfm_ns_client_identification.rst (renamed from docs/getting_started/tfm_ns_client_identification.rst)0
-rw-r--r--docs/technical_references/tfm_partition_and_service_design_document.rst (renamed from docs/design_documents/tfm_partition_and_service_design_document.rst)0
-rw-r--r--docs/technical_references/tfm_physical_attack_mitigation.rst (renamed from docs/design_documents/tfm_physical_attack_mitigation.rst)0
-rw-r--r--docs/technical_references/tfm_psa_inter_process_communication.rst (renamed from docs/design_documents/tfm_psa_inter_process_communication.rst)0
-rw-r--r--docs/technical_references/tfm_secure_boot.rst (renamed from docs/getting_started/tfm_secure_boot.rst)0
-rw-r--r--docs/technical_references/tfm_secure_irq_handling.rst (renamed from docs/getting_started/tfm_secure_irq_handling.rst)0
-rw-r--r--docs/technical_references/tfm_secure_partition_interrupt_handling.rst (renamed from docs/design_documents/tfm_secure_partition_interrupt_handling.rst)6
-rw-r--r--docs/technical_references/tfm_secure_partition_runtime_library.rst (renamed from docs/design_documents/tfm_secure_partition_runtime_library.rst)0
-rw-r--r--docs/technical_references/tfm_uniform_secure_service_signature.rst (renamed from docs/design_documents/tfm_uniform_secure_service_signature.rst)0
-rw-r--r--platform/ext/index.rst10
-rw-r--r--platform/ext/platform_deprecation.rst (renamed from docs/contributing/platform_deprecation.rst)0
-rw-r--r--platform/ext/target/musca_b1/secure_enclave/readme.rst4
-rw-r--r--readme.rst2
95 files changed, 163 insertions, 168 deletions
diff --git a/docs/contributing/code_review_guide.rst b/docs/contributing/code_review_guide.rst
index 8bbf33aa2..e9ed9699f 100644
--- a/docs/contributing/code_review_guide.rst
+++ b/docs/contributing/code_review_guide.rst
@@ -13,9 +13,9 @@ List of the guidelines
**********************
The prerequisites before going to the review stage:
-- Read the :doc:`Contributing Guidelines </docs/contributing/contributing>`
+- Read the :doc:`Contributing Process </docs/contributing/contributing_process>`
to know basic concepts.
-- Read the :doc:`Source Structure </docs/design_documents/source_structure>`
+- Read the :doc:`Source Structure </docs/technical_references/source_structure>`
for structure related reference.
The review guidelines consist of these items:
@@ -234,4 +234,4 @@ SPRTL secure-fw/partitions/lib/sprt/*
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/contributing/coding_guide.rst b/docs/contributing/coding_guide.rst
index 099d3b3fc..f208fc094 100644
--- a/docs/contributing/coding_guide.rst
+++ b/docs/contributing/coding_guide.rst
@@ -18,7 +18,7 @@ remain within clear scope.
The guidance below is provided as a help. It isn't meant to be a definitive
list.
-As implied in the :doc:`contributing guide </docs/contributing/contributing>`
+As implied in the :doc:`contributing guide </docs/contributing/contributing_process>`
maintainers have the right to decide on what's acceptable in case of any
divergence.
@@ -76,4 +76,4 @@ List of rules
--------------
-*Copyright (c) 2018-2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2018-2021, Arm Limited. All rights reserved.*
diff --git a/docs/contributing/contributing.rst b/docs/contributing/contributing_process.rst
index 9c80cab95..b017c638a 100644
--- a/docs/contributing/contributing.rst
+++ b/docs/contributing/contributing_process.rst
@@ -1,5 +1,5 @@
-Contributing
-============
+Contributing Process
+====================
Contributions to the TF-M project need to follow the process below.
@@ -77,4 +77,4 @@ Contributions to the TF-M project need to follow the process below.
--------------
-*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*
diff --git a/docs/contributing/doc_guidelines.rst b/docs/contributing/doc_guidelines.rst
index e217dde57..41f4e05c9 100644
--- a/docs/contributing/doc_guidelines.rst
+++ b/docs/contributing/doc_guidelines.rst
@@ -187,7 +187,7 @@ will not be added to the index (So it cannot be referenced if needed)
Other types of tables such as list-tables and csv-tables are also permitted, as
seen on :doc:`/docs/getting_started/tfm_sw_requirement` and
-:doc:`/docs/reference/releases/1.0`
+:doc:`/docs/releases/1.0`
External Links
@@ -260,7 +260,7 @@ Glossary term
=============
For technical terms and abbreviations, the recommended guidance is to add an
-entry to the :doc:`/docs/reference/glossary` and refer to it, using the `term:`
+entry to the :doc:`/docs/glossary` and refer to it, using the `term:`
directive
@@ -297,4 +297,4 @@ References
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
index 7b921f25d..e5f9c66be 100644
--- a/docs/contributing/index.rst
+++ b/docs/contributing/index.rst
@@ -1,15 +1,13 @@
-Contributing
-============
+Contribution Guidelines
+=======================
.. toctree::
:maxdepth: 1
- :caption: Contents
:glob:
*
- Security Center <https://developer.trustedfirmware.org/w/collaboration/security_center>
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/contributing/maintainers.rst b/docs/contributing/maintainers.rst
index aeced913b..ced48d167 100644
--- a/docs/contributing/maintainers.rst
+++ b/docs/contributing/maintainers.rst
@@ -111,8 +111,8 @@ Michel JAOUEN
:github: `jamike <https://github.com/jamike>`__
-Infineon/Cypress Platform:
-~~~~~~~~~~~~~~~~~
+Infineon/Cypress Platforms
+~~~~~~~~~~~~~~~~~~~~~~~~~~
Chris Brand
:email: `Chris Brand@cypress.com <chris.brand@cypress.com>`__
diff --git a/docs/contributing/tfm_design_proposal_process.rst b/docs/contributing/tfm_design_proposal_process.rst
index 0be4d04e7..fcc2be9d7 100644
--- a/docs/contributing/tfm_design_proposal_process.rst
+++ b/docs/contributing/tfm_design_proposal_process.rst
@@ -49,7 +49,7 @@ Example document fragment::
Design documents are kept in three different sections of the documentation
reflecting the status of the document. The status of the document determines
the section it is in. Open (*Draft* and *Detailed* status) and accepted design
-documents shall be put to the ``docs/design_documents`` directory.
+documents shall be put to the ``docs/technical_references`` directory.
.. important::
- 'Author' and 'Organization' can be *OPTIONAL* but at least one of them is
@@ -78,7 +78,7 @@ Process steps
- Write the design proposal in the format that is described in this document
with the *Status* set to *Draft* if *Status* field is provided. Put it to the
- ``docs/design_documents`` directory and create a pull request.
+ ``docs/technical_references`` directory and create a pull request.
- Start an e-mail thread on the
`TF-M mailing list <mailto:tf-m@lists.trustedfirmware.org>`_ for discussing
the proposal.
@@ -98,8 +98,8 @@ Process steps
.. uml::
@startuml
- !define DRAFT_DIR **docs/design_documents/**
- !define REJECTED_DIR **docs/design_documents/rejected/**
+ !define DRAFT_DIR **docs/technical_references/**
+ !define REJECTED_DIR **docs/technical_references/rejected/**
!define GERRIT_URL https://review.trustedfirmware.org
!define GERRIT_LINK [[GERRIT_URL trustedfirmware.org]]
!define MAINTAINER_RST_URL https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/tree/docs/maintainers.rst
@@ -153,4 +153,4 @@ Process steps
--------------
-*Copyright (c) 2019-2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2019-2021, Arm Limited. All rights reserved.*
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
index 4b08906f8..c6d8d3497 100644
--- a/docs/getting_started/index.rst
+++ b/docs/getting_started/index.rst
@@ -2,12 +2,15 @@ Getting Started Guides
======================
.. toctree::
:maxdepth: 1
- :caption: Contents
:glob:
:numbered:
- *
+ tfm_sw_requirement
+ tfm_build_instruction
+ tfm_build_instruction_iar
+ tfm_user_guide
+ /tools/index
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index cdfcab549..453d1d9ad 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -167,7 +167,7 @@ TF-M Profiles
TF-M Profiles are implemented as a single cmake configuration file, under the
``config/profile`` directory. A good understanding can be gained quickly by
looking at the Profile configuration files, but the ultimate reference for
-Profiles are the design documents in the ``docs/design_documents/profiles/``
+Profiles are the design documents in the ``docs/technical_references/profiles/``
directory.
PSA test configuration
@@ -563,4 +563,4 @@ Alternately using traditional cmake syntax
--------------
-*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*
diff --git a/docs/getting_started/tfm_user_guide.rst b/docs/getting_started/tfm_user_guide.rst
index 55648f49b..d2b01937c 100644
--- a/docs/getting_started/tfm_user_guide.rst
+++ b/docs/getting_started/tfm_user_guide.rst
@@ -5,8 +5,8 @@ How to compile and run TF-M and example test application for CoreLink
SSE-200 subsystem on the MPS2 board and on the Fast Model(FVP).
Follow :doc:`build instruction <tfm_build_instruction>` to build the binaries.
-Follow :doc:`secure boot <tfm_secure_boot>` to build the binaries with or
-without BL2 bootloader.
+Follow :doc:`secure boot </docs/technical_references/tfm_secure_boot>` to build the
+binaries with or without BL2 bootloader.
****************************************************************
Execute TF-M example and regression tests on MPS2 boards and FVP
@@ -565,7 +565,7 @@ port (baud 115200 8n1) the following messages::
Firmware upgrade and image validation with BL2 bootloader
=========================================================
High level operation of BL2 bootloader and instructions for testing firmware
-upgrade is described in :doc:`secure boot <tfm_secure_boot>`.
+upgrade is described in :doc:`secure boot </docs/technical_references/tfm_secure_boot>`.
--------------
@@ -576,4 +576,4 @@ upgrade is described in :doc:`secure boot <tfm_secure_boot>`.
.. _Keil MDK: http://www2.keil.com/mdk5
.. _Keil MDK Documentation: https://www2.keil.com/mdk5/docs
-*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*
diff --git a/docs/reference/glossary.rst b/docs/glossary.rst
index 73e91aa74..73e91aa74 100644
--- a/docs/reference/glossary.rst
+++ b/docs/glossary.rst
diff --git a/docs/index.rst b/docs/index.rst
index 219992916..fed9d425e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,7 +20,7 @@ Trusted Firmware-M Documentation
<h2>Introduction</h2>
</a>
<p>Introducing the Trusted Firmware-M Project: overview,
- architecture, features, and licensing</p>
+ architecture, features, and licensing.</p>
</li>
<li class="grid-item">
<a href="docs/getting_started/index.html">
@@ -31,6 +31,13 @@ Trusted Firmware-M Documentation
system, and then build and run a sample application.</p>
</li>
<li class="grid-item">
+ <a href="platform/ext/index.html">
+ <img alt="" src="_static/images/tfm.png"/>
+ <h2>Supported Platforms</h2>
+ </a>
+ <p>List of supported boards and platforms.</p>
+ </li>
+ <li class="grid-item">
<a href="docs/contributing/index.html">
<img alt="" src="_static/images/tfm.png"/>
<h2>Contribution Guidelines</h2>
@@ -39,39 +46,33 @@ Trusted Firmware-M Documentation
to submit patches directly to the project.</p>
</li>
<li class="grid-item">
- <a href="docs/reference/index.html">
+ <a href="docs/integration_guide/index.html">
<img alt="" src="_static/images/tfm.png"/>
- <h2>References</h2>
+ <h2>Integration Guidelines</h2>
</a>
- <p>User guides, API Documentation, interfaces</p>
+ <p>Guidelines for integration with TF-M.</p>
</li>
<li class="grid-item">
- <a href="docs/design_documents/index.html">
+ <a href="docs/technical_references/index.html">
<img alt="" src="_static/images/tfm.png"/>
- <h2>Design</h2>
+ <h2>Technical References</h2>
</a>
- <p>Design documents, threat models.</p>
+ <p>Design documents.</p>
</li>
<li class="grid-item">
- <a href="platform/ext/index.html">
+ <a href="docs/security/index.html">
<img alt="" src="_static/images/tfm.png"/>
- <h2>Platforms</h2>
+ <h2>Security</h2>
</a>
- <p>List of supported boards and platforms.</p>
+ <p>Requirements, processes, and thread models for ensuring security
+ is addressed within the TF-M project.</p>
</li>
<li class="grid-item">
- <a href="https://ci.trustedfirmware.org/view/TF-M/job/tf-m-build-docs-nightly/lastSuccessfulBuild/artifact/trusted-firmware-m/build/docs/reference_manual/html/index.html">
+ <a href="docs/releases/index.html">
<img alt="" src="_static/images/tfm.png"/>
- <h2>API</h2>
+ <h2>Releases</h2>
</a>
- <p>Doxygen documentation.</p>
- </li>
- <li class="grid-item">
- <a href="https://developer.arm.com/architectures/security-architectures/platform-security-architecture">
- <img alt="" src="_static/images/tfm.png"/>
- <h2>PSA</h2>
- </a>
- <p>Platform Security Architecture (PSA) information.</p>
+ <p>Release notes.</p>
</li>
</ul>
@@ -85,11 +86,12 @@ Trusted Firmware-M Documentation
Home<self>
docs/introduction/index
docs/getting_started/index
- docs/contributing/index
- docs/reference/index
- docs/design_documents/index
platform/ext/index
- docs/threat_models/index
+ docs/contributing/index
+ docs/integration_guide/index
+ docs/technical_references/index
+ docs/security/index
+ docs/releases/index
.. toctree::
@@ -97,11 +99,11 @@ Trusted Firmware-M Documentation
:hidden:
:caption: Quick Links
+ API Reference <https://ci.trustedfirmware.org/view/TF-M/job/tf-m-build-docs-nightly/lastSuccessfulBuild/artifact/trusted-firmware-m/build/docs/reference_manual/html/index.html>
Security Center <https://developer.trustedfirmware.org/w/collaboration/security_center>
- docs/reference/changelog
- docs/reference/glossary
- docs/contributing/lic
+ Platform Security Architecture <https://developer.arm.com/architectures/security-architectures/platform-security-architecture>
+ docs/glossary
--------------
-*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*
diff --git a/docs/integration_guide/index.rst b/docs/integration_guide/index.rst
new file mode 100644
index 000000000..41bc4d26a
--- /dev/null
+++ b/docs/integration_guide/index.rst
@@ -0,0 +1,12 @@
+Integration Guide
+=================
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ */index
+ *
+
+--------------
+
+*Copyright (c) 2020, Arm Limited. All rights reserved.*
diff --git a/docs/getting_started/os_migration_guide_armv8m.rst b/docs/integration_guide/os_migration_guide_armv8m.rst
index 752c33284..1ca4e3df0 100644
--- a/docs/getting_started/os_migration_guide_armv8m.rst
+++ b/docs/integration_guide/os_migration_guide_armv8m.rst
@@ -24,14 +24,14 @@ List of requirements
then it also have to use the
``enum tfm_status_e tfm_register_client_id (int32_t ns_client_id)``
API function provided by TF-M, as described in
- :doc:`NS client identification documentation <tfm_ns_client_identification>`.
+ :doc:`NS client identification documentation </docs/technical_references/tfm_ns_client_identification>`.
- if the OS doesn't support the API mentioned above, it should set
``TFM_NS_CLIENT_IDENTIFICATION`` to ``OFF`` in the cmake system.
- .. Note::
This is NOT REQUIRED when the Non Secure OS build is meant
to be integrated with TF-M running in Secure world.
-
+
If generic function calls into Secure world have to be supported in Non Secure
builds, integrate an API for secure stack memory management (e.g. the
TrustZone API for secure stack memory management described in
@@ -39,4 +39,4 @@ List of requirements
--------------
-*Copyright (c) 2018-2019, Arm Limited. All rights reserved.*
+*Copyright (c) 2018-2021, Arm Limited. All rights reserved.*
diff --git a/docs/reference/services/core_test_services_integration_guide.rst b/docs/integration_guide/services/core_test_services_integration_guide.rst
index fb3479565..fb3479565 100644
--- a/docs/reference/services/core_test_services_integration_guide.rst
+++ b/docs/integration_guide/services/core_test_services_integration_guide.rst
diff --git a/docs/reference/services/index.rst b/docs/integration_guide/services/index.rst
index 30a2a8a07..30a2a8a07 100644
--- a/docs/reference/services/index.rst
+++ b/docs/integration_guide/services/index.rst
diff --git a/docs/reference/services/tfm_attestation_integration_guide.rst b/docs/integration_guide/services/tfm_attestation_integration_guide.rst
index 2c43ea7bd..2c43ea7bd 100644
--- a/docs/reference/services/tfm_attestation_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_attestation_integration_guide.rst
diff --git a/docs/reference/services/tfm_audit_integration_guide.rst b/docs/integration_guide/services/tfm_audit_integration_guide.rst
index 248f0f9fb..248f0f9fb 100644
--- a/docs/reference/services/tfm_audit_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_audit_integration_guide.rst
diff --git a/docs/reference/services/tfm_crypto_integration_guide.rst b/docs/integration_guide/services/tfm_crypto_integration_guide.rst
index a124bdf49..a124bdf49 100644
--- a/docs/reference/services/tfm_crypto_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_crypto_integration_guide.rst
diff --git a/docs/reference/services/tfm_its_integration_guide.rst b/docs/integration_guide/services/tfm_its_integration_guide.rst
index 6082e7369..6082e7369 100644
--- a/docs/reference/services/tfm_its_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_its_integration_guide.rst
diff --git a/docs/reference/services/tfm_platform_integration_guide.rst b/docs/integration_guide/services/tfm_platform_integration_guide.rst
index 7858435ac..7858435ac 100644
--- a/docs/reference/services/tfm_platform_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_platform_integration_guide.rst
diff --git a/docs/reference/services/tfm_ps_integration_guide.rst b/docs/integration_guide/services/tfm_ps_integration_guide.rst
index 049f4b6d3..2c6da7b49 100644
--- a/docs/reference/services/tfm_ps_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_ps_integration_guide.rst
@@ -158,7 +158,7 @@ The ITS filesystem and flash interfaces and their implementation can be found in
``secure_fw/partitions/internal_trusted_storage/flash`` respectively. More
information about the filesystem and flash interfaces can be found in the
:doc:`ITS integration guide
-</docs/reference/services/tfm_its_integration_guide>`.
+</docs/integration_guide/services/tfm_its_integration_guide>`.
The ITS service implementation in
``secure_fw/partitions/internal_trusted_storage/tfm_internal_trusted_storage.c``,
@@ -293,14 +293,14 @@ TF-M core tracks the current client IDs running in the secure or non-secure
processing environment. It provides a dedicated API to retrieve the client ID
which performs the service request.
-:doc:`NS client identification documentation </docs/getting_started/tfm_ns_client_identification>`
+:doc:`NS client identification documentation </docs/technical_references/tfm_ns_client_identification>`
provides further details on how client identification works.
PS service uses that TF-M core API to retrieve the client ID and associate it
as the owner of an asset. Only the owner can read, write or delete that asset
based on the creation flags.
-The :doc:`integration guide </docs/getting_started/tfm_integration_guide>`
+The :doc:`integration guide </docs/integration_guide/tfm_integration_guide>`
provides further details of non-secure implementation requirements for TF-M.
Cryptographic Interface
diff --git a/docs/reference/services/tfm_psa_proxy_integration_guide.rst b/docs/integration_guide/services/tfm_psa_proxy_integration_guide.rst
index 2c5a389cc..2c0509b3f 100644
--- a/docs/reference/services/tfm_psa_proxy_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_psa_proxy_integration_guide.rst
@@ -9,7 +9,7 @@ TF-M PSA Proxy partition is responsible for forwarding all the PSA RoT messages
to a Secure Enclave, this way virtually providing all the PSA RoT services.
Proxy can only be used in IPC model, for context and design details please
check the
-:doc:`Secure Enclave design document <docs/design_documents/secure_enclave_solution.rst>`.
+:doc:`Secure Enclave design document </docs/technical_references/secure_enclave_solution>`.
Currently to forward the PSA Client call parameters Proxy must read them with
``psa_read`` into a memory area shared with the Secure Enclave. (Similarily
@@ -80,4 +80,4 @@ Integration Guide
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/reference/services/tfm_secure_partition_addition.rst b/docs/integration_guide/services/tfm_secure_partition_addition.rst
index 9343aab2d..9343aab2d 100644
--- a/docs/reference/services/tfm_secure_partition_addition.rst
+++ b/docs/integration_guide/services/tfm_secure_partition_addition.rst
diff --git a/docs/getting_started/tfm_integration_guide.rst b/docs/integration_guide/tfm_integration_guide.rst
index a37a4cb8d..c398fbf9d 100644
--- a/docs/getting_started/tfm_integration_guide.rst
+++ b/docs/integration_guide/tfm_integration_guide.rst
@@ -7,12 +7,12 @@ with other hardware platforms and operating systems.
*****************
How to build TF-M
*****************
-Follow the :doc:`Build instructions <tfm_build_instruction>`.
+Follow the :doc:`Build instructions </docs/getting_started/tfm_build_instruction>`.
********************************************************
How to export files for building non-secure applications
********************************************************
-Explained in the :doc:`Build instructions <tfm_build_instruction>`.
+Explained in the :doc:`Build instructions </docs/getting_started/tfm_build_instruction>`.
*************************
How to add a new platform
@@ -122,7 +122,7 @@ and returns the return value from the service to the caller.
The protected storage service uses a numerical ID, to identify the clients that
use the service. For details see
-:doc:`ns client identification documentation <tfm_ns_client_identification>`.
+:doc:`ns client identification documentation </docs/technical_references/tfm_ns_client_identification>`.
Interface with non-secure world regression tests
================================================
@@ -144,7 +144,7 @@ implementation of these wrappers to be able to run the tests.
NS client Identification
========================
See
-:doc:`ns client identification documentation <tfm_ns_client_identification>`.
+:doc:`ns client identification documentation </docs/technical_references/tfm_ns_client_identification>`.
*********************
Non-secure interrupts
diff --git a/docs/introduction/index.rst b/docs/introduction/index.rst
index 0fa3aae5a..bd1888887 100644
--- a/docs/introduction/index.rst
+++ b/docs/introduction/index.rst
@@ -3,7 +3,6 @@ Introduction
.. toctree::
:maxdepth: 1
- :caption: Introduction
:glob:
:numbered:
@@ -11,4 +10,4 @@ Introduction
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/introduction/readme.rst b/docs/introduction/readme.rst
index f57996dc8..2c422f680 100644
--- a/docs/introduction/readme.rst
+++ b/docs/introduction/readme.rst
@@ -37,15 +37,15 @@ the platform. TF-M is supported on several Cortex-M based
Systems (RTOS).
Terms ``TFM`` and ``TF-M`` are commonly used in documents and code and both
-refer to ``Trusted Firmware M.`` :doc:`Glossary </docs/reference/glossary>`
-has the list of terms and abbreviations.
+refer to ``Trusted Firmware M.`` :doc:`Glossary </docs/glossary>` has the list
+of terms and abbreviations.
#######
License
#######
The software is provided under a BSD-3-Clause :doc:`License </docs/contributing/lic>`.
Contributions to this project are accepted under the same license with developer
-sign-off as described in the :doc:`Contributing Guidelines </docs/contributing/contributing>`.
+sign-off as described in the :doc:`Contributing Guidelines </docs/contributing/contributing_process>`.
This project contains code from other projects as listed below. The code from
external projects is limited to ``app``, ``bl2``, ``lib`` and ``platform``
@@ -62,10 +62,10 @@ folders. The original license text is included in those source files.
#########################
Release Notes and Process
#########################
-The :doc:`Release Cadence and Process </docs/contributing/release_process>` provides
+The :doc:`Release Cadence and Process </docs/releases/release_process>` provides
release cadence and process information.
-The :doc:`Change Log & Release Notes </docs/reference/changelog>` provides details of
+The :doc:`Releases </docs/releases/index>` provides details of
major features of the release and platforms supported.
###############
@@ -102,11 +102,11 @@ To build & run TF-M:
on running the example.
To port TF-M to a another system or OS, follow the
-:doc:`OS Integration Guide </docs/getting_started/tfm_integration_guide>`
+:doc:`OS Integration Guide </docs/integration_guide/tfm_integration_guide>`
-Please also see the :doc:`glossary </docs/reference/glossary>` of terms used in the project.
+Please also see the :doc:`glossary </docs/glossary>` of terms used in the project.
-:doc:`Contributing Guidelines </docs/contributing/contributing>` contains guidance on how to
+: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.
@@ -162,7 +162,7 @@ Platforms supported
- :doc:`Musca-B1 Secure Enclave. </platform/ext/target/musca_b1/secure_enclave/readme>`
-The document :doc:`Platform Deprecation and Removal </docs/contributing/platform_deprecation>`
+The document :doc:`Platform Deprecation and Removal </platform/ext/platform_deprecation>`
lists the deprecated platforms planned to be removed from upstream.
####################
@@ -195,7 +195,7 @@ Version history
+-------------+--------------+--------------------+-------------------+
Please refer to
-:ref:`docs/contributing/release_process:Release Version Scheme` for interpreting
+: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
diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst
deleted file mode 100644
index 70a3e2816..000000000
--- a/docs/reference/changelog.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-##########################
-Change Log & Release Notes
-##########################
-
-This document contains a summary of the new features, changes, fixes and known
-issues in each release of Trusted Firmware-M.
-
-.. include:: ../reference/releases/1.3.0.rst
-.. include:: ../reference/releases/1.2.0.rst
-.. include:: ../reference/releases/1.1.rst
-.. include:: ../reference/releases/1.0.rst
-
---------------
-
-*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
deleted file mode 100644
index 7e8134998..000000000
--- a/docs/reference/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-Reference
-=========
-
-.. toctree::
- :maxdepth: 1
- :glob:
-
- changelog
- glossary
- security
- */index
- /tools/index
-
---------------
-
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
diff --git a/docs/reference/releases/1.0.rst b/docs/releases/1.0.rst
index 48903f501..48903f501 100644
--- a/docs/reference/releases/1.0.rst
+++ b/docs/releases/1.0.rst
diff --git a/docs/reference/releases/1.1.rst b/docs/releases/1.1.rst
index 83c45dfb5..83c45dfb5 100644
--- a/docs/reference/releases/1.1.rst
+++ b/docs/releases/1.1.rst
diff --git a/docs/reference/releases/1.2.0.rst b/docs/releases/1.2.0.rst
index 1c28632b1..832474db6 100644
--- a/docs/reference/releases/1.2.0.rst
+++ b/docs/releases/1.2.0.rst
@@ -12,7 +12,7 @@ New features
- Add Profile Medium.
- Migrate support to Mbed TLS v2.24.
- New platforms added.
- See :ref:`docs/reference/releases/1.2.0:New platforms supported` for
+ See :ref:`docs/releases/1.2.0:New platforms supported` for
details.
- New SPM HAL APIs including isolation API and logging API.
- Update MCUboot version to 1.7.0-rc1.
@@ -25,7 +25,7 @@ New security advisories
Stack sealing
-------------
-Refer to :doc:`Advisory TFMV-1</docs/reference/security_advisories/stack_seal_vulnerability>`
+Refer to :doc:`Advisory TFMV-1</docs/security/security_advisories/stack_seal_vulnerability>`
for more details.
A common mitigation is included in this release.
@@ -139,4 +139,4 @@ hardware limitations or 3rd-party tools and therefore won't be fixed by TF-M.
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/reference/releases/1.3.0.rst b/docs/releases/1.3.0.rst
index 80e3dd655..e246ad043 100644
--- a/docs/reference/releases/1.3.0.rst
+++ b/docs/releases/1.3.0.rst
@@ -18,7 +18,7 @@ New major features
- Support Armv8.1-M Privileged Execute Never (PXN) attribute and Thread
reentrancy disabled (TRD) feature.
- New platforms added.
- See :ref:`docs/reference/releases/1.3.0:New platforms supported` for
+ See :ref:`docs/releases/1.3.0:New platforms supported` for
details.
- Add a TF-M security landing page [7]_.
- Enhance dual-cpu non-secure mailbox reference implementation.
@@ -29,7 +29,7 @@ New security advisories
Invoking secure functions from non-secure handler mode
------------------------------------------------------
-Refer to :doc:`Advisory TFMV-2</docs/reference/security_advisories/svc_caller_sp_fetching_vulnerability>`
+Refer to :doc:`Advisory TFMV-2</docs/security/security_advisories/svc_caller_sp_fetching_vulnerability>`
for more details.
The mitigation is included in this release.
@@ -58,7 +58,7 @@ The following platforms have been removed from TF-M code base.
- SSE-200_AWS
- AN539
-See :doc:`Platform deprecation and removal </docs/contributing/platform_deprecation>`
+See :doc:`Platform deprecation and removal </platform/ext/platform_deprecation>`
for other platforms under deprecation process.
Tested platforms
@@ -158,15 +158,15 @@ Reference
.. [2] `PSA Firmware Update API <https://developer.arm.com/documentation/ihi0093/latest/>`_
- .. [3] :doc:`TF-M generic threat model </docs/threat_models/generic_threat_model>`
+ .. [3] :doc:`TF-M generic threat model </docs/security/threat_models/generic_threat_model>`
- .. [4] :doc:`TF-M physical attack mitigation </docs/design_documents/tfm_physical_attack_mitigation>`
+ .. [4] :doc:`TF-M physical attack mitigation </docs/technical_references/tfm_physical_attack_mitigation>`
- .. [5] :doc:`TF-M Profile Large design </docs/design_documents/profiles/tfm_profile_large>`
+ .. [5] :doc:`TF-M Profile Large design </docs/technical_references/profiles/tfm_profile_large>`
- .. [6] :doc:`Code sharing between independently linked XIP binaries </docs/design_documents/code_sharing>`
+ .. [6] :doc:`Code sharing between independently linked XIP binaries </docs/technical_references/code_sharing>`
- .. [7] :doc:`Security Handling </docs/reference/security>`
+ .. [7] :doc:`Security Handling </docs/security/security>`
--------------
diff --git a/docs/reference/releases/index.rst b/docs/releases/index.rst
index dc8aecbcd..dc8aecbcd 100644
--- a/docs/reference/releases/index.rst
+++ b/docs/releases/index.rst
diff --git a/docs/contributing/release_process.rst b/docs/releases/release_process.rst
index 8b6d1965b..8b6d1965b 100644
--- a/docs/contributing/release_process.rst
+++ b/docs/releases/release_process.rst
diff --git a/docs/security/index.rst b/docs/security/index.rst
new file mode 100644
index 000000000..22bdcba82
--- /dev/null
+++ b/docs/security/index.rst
@@ -0,0 +1,12 @@
+Security
+========
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ */index
+ *
+
+--------------
+
+*Copyright (c) 2021, Arm Limited. All rights reserved.*
diff --git a/docs/reference/security.rst b/docs/security/security.rst
index 67632a975..bab72f2fa 100644
--- a/docs/reference/security.rst
+++ b/docs/security/security.rst
@@ -53,8 +53,8 @@ Security Advisories
.. _issue tracker: https://developer.trustedfirmware.org/project/view/2/
.. _mailing list: https://lists.trustedfirmware.org/mailman/listinfo/tf-m
-.. |TFMV-1| replace:: :ref:`docs/reference/security_advisories/stack_seal_vulnerability:Advisory TFMV-1`
-.. |TFMV-2| replace:: :ref:`docs/reference/security_advisories/svc_caller_sp_fetching_vulnerability:Advisory TFMV-2`
+.. |TFMV-1| replace:: :ref:`docs/security/security_advisories/stack_seal_vulnerability:Advisory TFMV-1`
+.. |TFMV-2| replace:: :ref:`docs/security/security_advisories/svc_caller_sp_fetching_vulnerability:Advisory TFMV-2`
.. _TrustedFirmware.org security incident process: https://developer.trustedfirmware.org/w/collaboration/security_center/
@@ -62,4 +62,4 @@ Security Advisories
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.* \ No newline at end of file
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/reference/security_advisories/index.rst b/docs/security/security_advisories/index.rst
index 85119084e..85119084e 100644
--- a/docs/reference/security_advisories/index.rst
+++ b/docs/security/security_advisories/index.rst
diff --git a/docs/reference/security_advisories/stack_seal_vulnerability.rst b/docs/security/security_advisories/stack_seal_vulnerability.rst
index 2bf9d1a25..2bf9d1a25 100644
--- a/docs/reference/security_advisories/stack_seal_vulnerability.rst
+++ b/docs/security/security_advisories/stack_seal_vulnerability.rst
diff --git a/docs/reference/security_advisories/svc_caller_sp_fetching_vulnerability.rst b/docs/security/security_advisories/svc_caller_sp_fetching_vulnerability.rst
index 4a117243f..4a117243f 100644
--- a/docs/reference/security_advisories/svc_caller_sp_fetching_vulnerability.rst
+++ b/docs/security/security_advisories/svc_caller_sp_fetching_vulnerability.rst
diff --git a/docs/threat_models/TF-M-block-diagram.png b/docs/security/threat_models/TF-M-block-diagram.png
index e5d0371e2..e5d0371e2 100644
--- a/docs/threat_models/TF-M-block-diagram.png
+++ b/docs/security/threat_models/TF-M-block-diagram.png
Binary files differ
diff --git a/docs/threat_models/generic_threat_model.rst b/docs/security/threat_models/generic_threat_model.rst
index 7aa048ad3..5659c243e 100644
--- a/docs/threat_models/generic_threat_model.rst
+++ b/docs/security/threat_models/generic_threat_model.rst
@@ -1107,7 +1107,7 @@ Reference
.. [FF-M] `ArmĀ® Platform Security Architecture Firmware Framework 1.0 <https://developer.arm.com/-/media/Files/pdf/PlatformSecurityArchitecture/Architect/DEN0063-PSA_Firmware_Framework-1.0.0-2.pdf?revision=2d1429fa-4b5b-461a-a60e-4ef3d8f7f4b4>`_
-.. [DUAL-CPU-BOOT] :doc:`Booting a dual core system </docs/design_documents/dual-cpu/booting_a_dual_core_system>`
+.. [DUAL-CPU-BOOT] :doc:`Booting a dual core system </docs/technical_references/dual-cpu/booting_a_dual_core_system>`
.. [CVSS] `Common Vulnerability Scoring System Version 3.1 Calculator <https://www.first.org/cvss/calculator/3.1>`_
@@ -1115,15 +1115,15 @@ Reference
.. [STRIDE] `The STRIDE Threat Model <https://docs.microsoft.com/en-us/previous-versions/commerce-server/ee823878(v=cs.20)?redirectedfrom=MSDN>`_
-.. [SECURE-BOOT] :doc:`Secure boot </docs/getting_started/tfm_secure_boot>`
+.. [SECURE-BOOT] :doc:`Secure boot </docs/technical_references/tfm_secure_boot>`
-.. [ROLLBACK-PROTECT] :doc:`Rollback protection in TF-M secure boot </docs/design_documents/secure_boot_rollback_protection>`
+.. [ROLLBACK-PROTECT] :doc:`Rollback protection in TF-M secure boot </docs/technical_references/secure_boot_rollback_protection>`
.. [STACK-SEAL] `Armv8-M processor Secure software Stack Sealing vulnerability <https://developer.arm.com/support/arm-security-updates/armv8-m-stack-sealing>`_
-.. [ADVISORY-TFMV-1] :doc:`Advisory TFMV-1 </docs/reference/security_advisories/stack_seal_vulnerability>`
+.. [ADVISORY-TFMV-1] :doc:`Advisory TFMV-1 </docs/security/security_advisories/stack_seal_vulnerability>`
-.. [ADVISORY-TFMV-2] :doc:`Advisory TFMV-2 </docs/reference/security_advisories/svc_caller_sp_fetching_vulnerability>`
+.. [ADVISORY-TFMV-2] :doc:`Advisory TFMV-2 </docs/security/security_advisories/svc_caller_sp_fetching_vulnerability>`
--------------------
diff --git a/docs/threat_models/index.rst b/docs/security/threat_models/index.rst
index 227d4d41e..227d4d41e 100644
--- a/docs/threat_models/index.rst
+++ b/docs/security/threat_models/index.rst
diff --git a/docs/threat_models/overall-DFD.png b/docs/security/threat_models/overall-DFD.png
index 39cf4c854..39cf4c854 100644
--- a/docs/threat_models/overall-DFD.png
+++ b/docs/security/threat_models/overall-DFD.png
Binary files differ
diff --git a/docs/design_documents/code_sharing.rst b/docs/technical_references/code_sharing.rst
index 45aec7e01..45aec7e01 100644
--- a/docs/design_documents/code_sharing.rst
+++ b/docs/technical_references/code_sharing.rst
diff --git a/docs/design_documents/dual-cpu/booting_a_dual_core_system.rst b/docs/technical_references/dual-cpu/booting_a_dual_core_system.rst
index 0a88ab367..0a88ab367 100644
--- a/docs/design_documents/dual-cpu/booting_a_dual_core_system.rst
+++ b/docs/technical_references/dual-cpu/booting_a_dual_core_system.rst
diff --git a/docs/design_documents/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst b/docs/technical_references/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
index 2bb3762ae..2bb3762ae 100644
--- a/docs/design_documents/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
+++ b/docs/technical_references/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
diff --git a/docs/design_documents/dual-cpu/dual_core_mailbox_arch.png b/docs/technical_references/dual-cpu/dual_core_mailbox_arch.png
index 79f565446..79f565446 100644
--- a/docs/design_documents/dual-cpu/dual_core_mailbox_arch.png
+++ b/docs/technical_references/dual-cpu/dual_core_mailbox_arch.png
Binary files differ
diff --git a/docs/design_documents/dual-cpu/index.rst b/docs/technical_references/dual-cpu/index.rst
index f30274833..f30274833 100644
--- a/docs/design_documents/dual-cpu/index.rst
+++ b/docs/technical_references/dual-cpu/index.rst
diff --git a/docs/design_documents/dual-cpu/mailbox_design_on_dual_core_system.rst b/docs/technical_references/dual-cpu/mailbox_design_on_dual_core_system.rst
index 60ac467d0..60ac467d0 100644
--- a/docs/design_documents/dual-cpu/mailbox_design_on_dual_core_system.rst
+++ b/docs/technical_references/dual-cpu/mailbox_design_on_dual_core_system.rst
diff --git a/docs/design_documents/dual-cpu/tfm_multi_core_access_check.rst b/docs/technical_references/dual-cpu/tfm_multi_core_access_check.rst
index 9ea9afdfe..9ea9afdfe 100644
--- a/docs/design_documents/dual-cpu/tfm_multi_core_access_check.rst
+++ b/docs/technical_references/dual-cpu/tfm_multi_core_access_check.rst
diff --git a/docs/design_documents/enum_implicit_casting.rst b/docs/technical_references/enum_implicit_casting.rst
index 01c8ce73f..01c8ce73f 100644
--- a/docs/design_documents/enum_implicit_casting.rst
+++ b/docs/technical_references/enum_implicit_casting.rst
diff --git a/docs/design_documents/ff_isolation.rst b/docs/technical_references/ff_isolation.rst
index b60b03eb2..41dd4fc0f 100644
--- a/docs/design_documents/ff_isolation.rst
+++ b/docs/technical_references/ff_isolation.rst
@@ -10,7 +10,7 @@ isolation and introduces the reference implementation in TF-M, which
complies the rules by operating the hardware and software resources.
.. note::
- Reference the document :doc:`Glossary </docs/reference/glossary>` for terms
+ Reference the document :doc:`Glossary </docs/glossary>` for terms
and abbreviations.
************
@@ -398,4 +398,4 @@ Appendix
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/design_documents/hardware_abstraction_layer.rst b/docs/technical_references/hardware_abstraction_layer.rst
index 588e5faad..645426f61 100644
--- a/docs/design_documents/hardware_abstraction_layer.rst
+++ b/docs/technical_references/hardware_abstraction_layer.rst
@@ -61,7 +61,7 @@ Here lists a minimal set of necessary functionalities:
- There is a non-secure :term:`HAL` that focuses on the mailbox operation API
for Dual-core topology. For more information about it, please refer to
:doc:`Mailbox Design in TF-M on Dual-core System
- </docs/design_documents/dual-cpu/mailbox_design_on_dual_core_system>`.
+ </docs/technical_references/dual-cpu/mailbox_design_on_dual_core_system>`.
- The minimal set of :term:`TF-M` :term:`HAL` is sufficient for Secure
Partitions by using customized peripheral interfaces. To provide easier
portability for the Secure Partitions, a Secure Partition :term:`HAL` is
diff --git a/docs/design_documents/index.rst b/docs/technical_references/index.rst
index 9f85a7650..bd7c57203 100644
--- a/docs/design_documents/index.rst
+++ b/docs/technical_references/index.rst
@@ -1,5 +1,5 @@
-Design Documents
-================
+Technical References
+====================
.. toctree::
:maxdepth: 2
diff --git a/docs/design_documents/index.rst.in b/docs/technical_references/index.rst.in
index b5cf149af..b5cf149af 100644
--- a/docs/design_documents/index.rst.in
+++ b/docs/technical_references/index.rst.in
diff --git a/docs/design_documents/media/hal_structure.png b/docs/technical_references/media/hal_structure.png
index 0f4c4c001..0f4c4c001 100644
--- a/docs/design_documents/media/hal_structure.png
+++ b/docs/technical_references/media/hal_structure.png
Binary files differ
diff --git a/docs/design_documents/media/symmetric_initial_attest/attest_token_finish.png b/docs/technical_references/media/symmetric_initial_attest/attest_token_finish.png
index 548e79d3d..548e79d3d 100644
--- a/docs/design_documents/media/symmetric_initial_attest/attest_token_finish.png
+++ b/docs/technical_references/media/symmetric_initial_attest/attest_token_finish.png
Binary files differ
diff --git a/docs/design_documents/media/symmetric_initial_attest/attest_token_start.png b/docs/technical_references/media/symmetric_initial_attest/attest_token_start.png
index ac39cf258..ac39cf258 100644
--- a/docs/design_documents/media/symmetric_initial_attest/attest_token_start.png
+++ b/docs/technical_references/media/symmetric_initial_attest/attest_token_start.png
Binary files differ
diff --git a/docs/design_documents/media/symmetric_initial_attest/ia_service_flow.png b/docs/technical_references/media/symmetric_initial_attest/ia_service_flow.png
index 288bc534f..288bc534f 100644
--- a/docs/design_documents/media/symmetric_initial_attest/ia_service_flow.png
+++ b/docs/technical_references/media/symmetric_initial_attest/ia_service_flow.png
Binary files differ
diff --git a/docs/design_documents/media/symmetric_initial_attest/iat_decode.png b/docs/technical_references/media/symmetric_initial_attest/iat_decode.png
index e35183bac..e35183bac 100644
--- a/docs/design_documents/media/symmetric_initial_attest/iat_decode.png
+++ b/docs/technical_references/media/symmetric_initial_attest/iat_decode.png
Binary files differ
diff --git a/docs/design_documents/media/symmetric_initial_attest/overall_diagram.png b/docs/technical_references/media/symmetric_initial_attest/overall_diagram.png
index 893c62eed..893c62eed 100644
--- a/docs/design_documents/media/symmetric_initial_attest/overall_diagram.png
+++ b/docs/technical_references/media/symmetric_initial_attest/overall_diagram.png
Binary files differ
diff --git a/docs/design_documents/media/tfm_crypto_design.png b/docs/technical_references/media/tfm_crypto_design.png
index 6e8d48b20..6e8d48b20 100644
--- a/docs/design_documents/media/tfm_crypto_design.png
+++ b/docs/technical_references/media/tfm_crypto_design.png
Binary files differ
diff --git a/docs/design_documents/profiles/index.rst b/docs/technical_references/profiles/index.rst
index e856cf807..e856cf807 100644
--- a/docs/design_documents/profiles/index.rst
+++ b/docs/technical_references/profiles/index.rst
diff --git a/docs/design_documents/profiles/tfm_profile_large.rst b/docs/technical_references/profiles/tfm_profile_large.rst
index 31c67c39f..2e0bc76de 100644
--- a/docs/design_documents/profiles/tfm_profile_large.rst
+++ b/docs/technical_references/profiles/tfm_profile_large.rst
@@ -436,9 +436,9 @@ instruction guide [9]_.
Reference
*********
-.. [1] :doc:`Trusted Firmware-M Profile Small Design </docs/design_documents/profiles/tfm_profile_small>`
+.. [1] :doc:`Trusted Firmware-M Profile Small Design </docs/technical_references/profiles/tfm_profile_small>`
-.. [2] :doc:`Trusted Firmware-M Profile Medium Design </docs/design_documents/profiles/tfm_profile_medium>`
+.. [2] :doc:`Trusted Firmware-M Profile Medium Design </docs/technical_references/profiles/tfm_profile_medium>`
.. [3] `PSA Certified Level 3 Lightweight Protection Profile <https://www.psacertified.org/app/uploads/2020/12/JSADEN009-PSA_Certified_Level_3_LW_PP-1.0-BET02.pdf>`_
@@ -446,11 +446,11 @@ Reference
.. [5] `The Transport Layer Security (TLS) Protocol Version 1.2 <https://tools.ietf.org/html/rfc5246>`_
-.. [6] `Physical attack mitigation in Trusted Firmware-M </docs/design_documents/tfm_physical_attack_mitigation>`
+.. [6] :doc:`Physical attack mitigation in Trusted Firmware-M </docs/technical_references/tfm_physical_attack_mitigation>`
-.. [7] :doc:`Crypto design </docs/design_documents/tfm_crypto_design>`
+.. [7] :doc:`Crypto design </docs/technical_references/tfm_crypto_design>`
-.. [8] :doc:`ITS integration guide </docs/reference/services/tfm_its_integration_guide>`
+.. [8] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
.. [9] :doc:`TF-M build instruction </docs/getting_started/tfm_build_instruction>`
diff --git a/docs/design_documents/profiles/tfm_profile_medium.rst b/docs/technical_references/profiles/tfm_profile_medium.rst
index 8413635cc..b1ab1c178 100644
--- a/docs/design_documents/profiles/tfm_profile_medium.rst
+++ b/docs/technical_references/profiles/tfm_profile_medium.rst
@@ -458,7 +458,7 @@ Reference
.. [RFC7925] `Transport Layer Security (TLS) / Datagram Transport Layer Security (DTLS) Profiles for the Internet of Things <https://tools.ietf.org/html/rfc7925>`_
-.. [PROFILE-S] :doc:`Trusted Firmware-M Profile Small Design </docs/design_documents/profiles/tfm_profile_small>`
+.. [PROFILE-S] :doc:`Trusted Firmware-M Profile Small Design </docs/technical_references/profiles/tfm_profile_small>`
.. [RFC7252] `The Constrained Application Protocol (CoAP) <https://tools.ietf.org/html/rfc7252>`_
@@ -466,12 +466,12 @@ Reference
.. [RFC7251] `AES-CCM Elliptic Curve Cryptography (ECC) Cipher Suites for TLS <https://tools.ietf.org/html/rfc7251>`_
-.. [CRYPTO-DESIGN] :doc:`Crypto design </docs/design_documents/tfm_crypto_design>`
+.. [CRYPTO-DESIGN] :doc:`Crypto design </docs/technical_references/tfm_crypto_design>`
-.. [ITS-INTEGRATE] :doc:`ITS integration guide </docs/reference/services/tfm_its_integration_guide>`
+.. [ITS-INTEGRATE] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
.. [TFM-BUILD] :doc:`TF-M build instruction </docs/getting_started/tfm_build_instruction>`
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/design_documents/profiles/tfm_profile_small.rst b/docs/technical_references/profiles/tfm_profile_small.rst
index abd49c8c8..189b1a56a 100644
--- a/docs/design_documents/profiles/tfm_profile_small.rst
+++ b/docs/technical_references/profiles/tfm_profile_small.rst
@@ -630,16 +630,16 @@ Reference
.. [6] `Transitioning the Use of Cryptographic Algorithms and Key Lengths <https://www.nist.gov/publications/transitioning-use-cryptographic-algorithms-and-key-lengths>`_
-.. [7] :doc:`ITS integration guide </docs/reference/services/tfm_its_integration_guide>`
+.. [7] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
.. [8] `PSA Attestation API 1.0 (ARM IHI 0085) <https://developer.arm.com/-/media/Files/pdf/PlatformSecurityArchitecture/Implement/IHI0085-PSA_Attestation_API-1.0.2.pdf?revision=eef78753-c77e-4b24-bcf0-65596213b4c1&la=en&hash=E5E0353D612077AFDCE3F2F3708A50C77A74B2A3>`_
-.. [9] :doc:`Secure boot </docs/getting_started/tfm_secure_boot>`
+.. [9] :doc:`Secure boot </docs/technical_references/tfm_secure_boot>`
-.. [10] :doc:`Crypto design </docs/design_documents/tfm_crypto_design>`
+.. [10] :doc:`Crypto design </docs/technical_references/tfm_crypto_design>`
.. [11] :doc:`TF-M build instruction </docs/getting_started/tfm_build_instruction>`
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/design_documents/ps_key_management.rst b/docs/technical_references/ps_key_management.rst
index 80a39be49..80a39be49 100644
--- a/docs/design_documents/ps_key_management.rst
+++ b/docs/technical_references/ps_key_management.rst
diff --git a/docs/design_documents/secure_boot_hw_key_integration.rst b/docs/technical_references/secure_boot_hw_key_integration.rst
index 186e4a649..186e4a649 100644
--- a/docs/design_documents/secure_boot_hw_key_integration.rst
+++ b/docs/technical_references/secure_boot_hw_key_integration.rst
diff --git a/docs/design_documents/secure_boot_rollback_protection.rst b/docs/technical_references/secure_boot_rollback_protection.rst
index 711fac321..711fac321 100644
--- a/docs/design_documents/secure_boot_rollback_protection.rst
+++ b/docs/technical_references/secure_boot_rollback_protection.rst
diff --git a/docs/design_documents/secure_enclave_solution.rst b/docs/technical_references/secure_enclave_solution.rst
index ce665ac22..ce665ac22 100644
--- a/docs/design_documents/secure_enclave_solution.rst
+++ b/docs/technical_references/secure_enclave_solution.rst
diff --git a/docs/design_documents/source_structure.rst b/docs/technical_references/source_structure.rst
index a549bf751..b2de0dda2 100644
--- a/docs/design_documents/source_structure.rst
+++ b/docs/technical_references/source_structure.rst
@@ -6,7 +6,7 @@ Trusted Firmware-M Source Structure
:Contact: tf-m@lists.trustedfirmware.org
.. note::
- Reference the document :doc:`Glossary </docs/reference/glossary>` for terms
+ Reference the document :doc:`Glossary </docs/glossary>` for terms
and abbreviations.
************
@@ -162,4 +162,4 @@ cmsis_func/\* The library model implementation. [2]
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/design_documents/symmetric_initial_attest.rst b/docs/technical_references/symmetric_initial_attest.rst
index 00642b87e..b53ab3c87 100644
--- a/docs/design_documents/symmetric_initial_attest.rst
+++ b/docs/technical_references/symmetric_initial_attest.rst
@@ -588,9 +588,9 @@ Reference
.. [1] `PSA Attestation API 1.0 (ARM IHI 0085) <https://developer.arm.com/-/media/Files/pdf/PlatformSecurityArchitecture/Implement/IHI0085-PSA_Attestation_API-1.0.2.pdf?revision=eef78753-c77e-4b24-bcf0-65596213b4c1&la=en&hash=E5E0353D612077AFDCE3F2F3708A50C77A74B2A3>`_
-.. [2] :doc:`Trusted Firmware-M Profile Small Design </docs/design_documents/profiles/tfm_profile_small>`
+.. [2] :doc:`Trusted Firmware-M Profile Small Design </docs/technical_references/profiles/tfm_profile_small>`
-.. [3] :doc:`Initial Attestation Service Integration Guide </docs/reference/services/tfm_attestation_integration_guide>`
+.. [3] :doc:`Initial Attestation Service Integration Guide </docs/integration_guide/services/tfm_attestation_integration_guide>`
.. [4] `HMAC: Keyed-Hashing for Message Authentication <https://tools.ietf.org/html/rfc2104>`_
@@ -598,4 +598,4 @@ Reference
----------------
-*Copyright (c) 2020 Arm Limited. All Rights Reserved.*
+*Copyright (c) 2020-2021 Arm Limited. All Rights Reserved.*
diff --git a/docs/design_documents/tfm_code_generation_with_jinja2.rst b/docs/technical_references/tfm_code_generation_with_jinja2.rst
index 2e730238d..2e730238d 100644
--- a/docs/design_documents/tfm_code_generation_with_jinja2.rst
+++ b/docs/technical_references/tfm_code_generation_with_jinja2.rst
diff --git a/docs/design_documents/tfm_cooperative_scheduling_rules.rst b/docs/technical_references/tfm_cooperative_scheduling_rules.rst
index b1c4e768b..b1c4e768b 100644
--- a/docs/design_documents/tfm_cooperative_scheduling_rules.rst
+++ b/docs/technical_references/tfm_cooperative_scheduling_rules.rst
diff --git a/docs/design_documents/tfm_crypto_design.rst b/docs/technical_references/tfm_crypto_design.rst
index e2785a5df..e2785a5df 100644
--- a/docs/design_documents/tfm_crypto_design.rst
+++ b/docs/technical_references/tfm_crypto_design.rst
diff --git a/docs/design_documents/tfm_fwu_service.rst b/docs/technical_references/tfm_fwu_service.rst
index 6d90de457..6d90de457 100644
--- a/docs/design_documents/tfm_fwu_service.rst
+++ b/docs/technical_references/tfm_fwu_service.rst
diff --git a/docs/design_documents/tfm_its_512_flash.rst b/docs/technical_references/tfm_its_512_flash.rst
index aa58c2b03..aa58c2b03 100644
--- a/docs/design_documents/tfm_its_512_flash.rst
+++ b/docs/technical_references/tfm_its_512_flash.rst
diff --git a/docs/design_documents/tfm_its_service.rst b/docs/technical_references/tfm_its_service.rst
index a9c71b7ac..a9c71b7ac 100644
--- a/docs/design_documents/tfm_its_service.rst
+++ b/docs/technical_references/tfm_its_service.rst
diff --git a/docs/design_documents/tfm_log_system_design_document.rst b/docs/technical_references/tfm_log_system_design_document.rst
index 269bcfc69..269bcfc69 100644
--- a/docs/design_documents/tfm_log_system_design_document.rst
+++ b/docs/technical_references/tfm_log_system_design_document.rst
diff --git a/docs/design_documents/tfm_non-secure_interrupt_handling.rst b/docs/technical_references/tfm_non-secure_interrupt_handling.rst
index 6560a0cf8..6560a0cf8 100644
--- a/docs/design_documents/tfm_non-secure_interrupt_handling.rst
+++ b/docs/technical_references/tfm_non-secure_interrupt_handling.rst
diff --git a/docs/design_documents/tfm_non_secure_client_management.rst b/docs/technical_references/tfm_non_secure_client_management.rst
index 970550aa4..970550aa4 100644
--- a/docs/design_documents/tfm_non_secure_client_management.rst
+++ b/docs/technical_references/tfm_non_secure_client_management.rst
diff --git a/docs/getting_started/tfm_ns_client_identification.rst b/docs/technical_references/tfm_ns_client_identification.rst
index 44fd3435a..44fd3435a 100644
--- a/docs/getting_started/tfm_ns_client_identification.rst
+++ b/docs/technical_references/tfm_ns_client_identification.rst
diff --git a/docs/design_documents/tfm_partition_and_service_design_document.rst b/docs/technical_references/tfm_partition_and_service_design_document.rst
index 500e7a11d..500e7a11d 100644
--- a/docs/design_documents/tfm_partition_and_service_design_document.rst
+++ b/docs/technical_references/tfm_partition_and_service_design_document.rst
diff --git a/docs/design_documents/tfm_physical_attack_mitigation.rst b/docs/technical_references/tfm_physical_attack_mitigation.rst
index a167d1253..a167d1253 100644
--- a/docs/design_documents/tfm_physical_attack_mitigation.rst
+++ b/docs/technical_references/tfm_physical_attack_mitigation.rst
diff --git a/docs/design_documents/tfm_psa_inter_process_communication.rst b/docs/technical_references/tfm_psa_inter_process_communication.rst
index 19691711b..19691711b 100644
--- a/docs/design_documents/tfm_psa_inter_process_communication.rst
+++ b/docs/technical_references/tfm_psa_inter_process_communication.rst
diff --git a/docs/getting_started/tfm_secure_boot.rst b/docs/technical_references/tfm_secure_boot.rst
index 95d3f68ed..95d3f68ed 100644
--- a/docs/getting_started/tfm_secure_boot.rst
+++ b/docs/technical_references/tfm_secure_boot.rst
diff --git a/docs/getting_started/tfm_secure_irq_handling.rst b/docs/technical_references/tfm_secure_irq_handling.rst
index 8cd664e26..8cd664e26 100644
--- a/docs/getting_started/tfm_secure_irq_handling.rst
+++ b/docs/technical_references/tfm_secure_irq_handling.rst
diff --git a/docs/design_documents/tfm_secure_partition_interrupt_handling.rst b/docs/technical_references/tfm_secure_partition_interrupt_handling.rst
index 47a3db512..6d9a5e1d0 100644
--- a/docs/design_documents/tfm_secure_partition_interrupt_handling.rst
+++ b/docs/technical_references/tfm_secure_partition_interrupt_handling.rst
@@ -40,8 +40,8 @@ manifest file IRQ declaration example
]}
See
-:doc:`secure IRQ handling <../getting_started/tfm_secure_irq_handling>` for
-further information on IRQ source and signal.
+:doc:`secure IRQ handling </docs/technical_references/tfm_secure_irq_handling>`
+for further information on IRQ source and signal.
Partition ISR function
======================
@@ -231,4 +231,4 @@ Does not return: The call is invalid, one or more of the following are true:
- ``irq_signal`` indicates more than one signal.
- ``irq_signal`` is not currently asserted.
-*Copyright (c) 2019-2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2019-2021, Arm Limited. All rights reserved.*
diff --git a/docs/design_documents/tfm_secure_partition_runtime_library.rst b/docs/technical_references/tfm_secure_partition_runtime_library.rst
index 97e844417..97e844417 100644
--- a/docs/design_documents/tfm_secure_partition_runtime_library.rst
+++ b/docs/technical_references/tfm_secure_partition_runtime_library.rst
diff --git a/docs/design_documents/tfm_uniform_secure_service_signature.rst b/docs/technical_references/tfm_uniform_secure_service_signature.rst
index 70c6c6031..70c6c6031 100644
--- a/docs/design_documents/tfm_uniform_secure_service_signature.rst
+++ b/docs/technical_references/tfm_uniform_secure_service_signature.rst
diff --git a/platform/ext/index.rst b/platform/ext/index.rst
index d763c7c73..1d12b9a7c 100644
--- a/platform/ext/index.rst
+++ b/platform/ext/index.rst
@@ -1,13 +1,13 @@
-Platforms
-=========
+Supported Platforms
+===================
.. toctree::
:maxdepth: 1
:caption: Information
- readme
/platform/readme
- /docs/contributing/platform_deprecation.rst
+ readme
+ /platform/ext/platform_deprecation.rst
.. toctree::
:maxdepth: 4
@@ -55,4 +55,4 @@ Platforms
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/contributing/platform_deprecation.rst b/platform/ext/platform_deprecation.rst
index 5d7a3de98..5d7a3de98 100644
--- a/docs/contributing/platform_deprecation.rst
+++ b/platform/ext/platform_deprecation.rst
diff --git a/platform/ext/target/musca_b1/secure_enclave/readme.rst b/platform/ext/target/musca_b1/secure_enclave/readme.rst
index 8b301aa37..a9af49577 100644
--- a/platform/ext/target/musca_b1/secure_enclave/readme.rst
+++ b/platform/ext/target/musca_b1/secure_enclave/readme.rst
@@ -17,7 +17,7 @@ SSE-200 subsystem used. But if the ``FORWARD_PROT_MSG`` cmake flag is turned
on, the TF-M instance running on SSE-200 will communicate with the SE.
For more information you can check the
-:doc:`Secure Enclave design document <docs/design_documents/secure_enclave_solution.rst>`.
+:doc:`Secure Enclave design document </docs/technical_references/secure_enclave_solution>`.
***********
System boot
@@ -102,4 +102,4 @@ Known limitations
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/readme.rst b/readme.rst
index abace9fad..4f21e380e 100644
--- a/readme.rst
+++ b/readme.rst
@@ -45,6 +45,6 @@ Feedback can be submitted via email to
.. _Trusted Firmware-M documentation: `Documentation home`_
.. _Documentation home: https://ci.trustedfirmware.org/job/tf-m-build-docs-nightly/lastStableBuild/artifact/trusted-firmware-m/build/docs/user_guide/html/index.html
.. _trustedfirmware.org: http://www.trustedfirmware.org
-.. _Release notes: https://ci.trustedfirmware.org/view/TF-M/job/tf-m-build-docs-nightly/lastSuccessfulBuild/artifact/trusted-firmware-m/build/docs/user_guide/html/docs/reference/changelog.html
+.. _Release notes: https://ci.trustedfirmware.org/view/TF-M/job/tf-m-build-docs-nightly/lastSuccessfulBuild/artifact/trusted-firmware-m/build/docs/user_guide/html/docs/reference/releases/index.html
*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*