Docs: Minor restructuring of partition's docs
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: Ie13f2c823f2b4b6324d95ad2559e02ef331a7590
diff --git a/docs/conf.py b/docs/conf.py
index a143d5c..1d46b75 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,7 +13,6 @@
# http://www.sphinx-doc.org/en/master/config
import os
-import sys
import re
from subprocess import check_output
@@ -91,9 +90,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'readme.rst',
- 'platform/cypress/psoc64/security/keys/readme.rst',
- 'lib/ext/**']
+exclude_patterns = ['_build', 'Thumbs.db', 'readme.rst']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
diff --git a/docs/partitions/adac/adac_integration_guide.rst b/docs/partitions/adac/adac_integration_guide.rst
index 3cb9883..c1cb3e7 100644
--- a/docs/partitions/adac/adac_integration_guide.rst
+++ b/docs/partitions/adac/adac_integration_guide.rst
@@ -2,6 +2,11 @@
ADAC (Authenticated Debug Access Control)
#########################################
+.. toctree::
+ :maxdepth: 1
+
+ ADAC Implementation for RSE <adac_impl_for_rse>
+
************
Introduction
************
diff --git a/docs/partitions/adac/index.rst b/docs/partitions/adac/index.rst
deleted file mode 100644
index 4938893..0000000
--- a/docs/partitions/adac/index.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-##################################
-Authenticated Debug Access Control
-##################################
-
-.. toctree::
- :maxdepth: 1
-
- ADAC Service Integration Guide <adac_integration_guide>
- ADAC Implementation for RSE <adac_impl_for_rse>
-
---------------
-
-*Copyright (c) 2024, Arm Limited. All rights reserved.*
diff --git a/docs/partitions/dma350_unpriv_partition/dma350_unpriv_partition.rst b/docs/partitions/dma350_unpriv_partition/dma350_unpriv_partition.rst
index 641b524..39b363d 100644
--- a/docs/partitions/dma350_unpriv_partition/dma350_unpriv_partition.rst
+++ b/docs/partitions/dma350_unpriv_partition/dma350_unpriv_partition.rst
@@ -2,6 +2,11 @@
Readme
######
+.. toctree::
+ :maxdepth: 1
+
+ DMA-350 privilege separation <dma350_privilege_separation>
+
TF-M application root of trust partition example for the unprivileged DMA-350
library. It is expected to be used in Isolation Level 2, as the unprivileged API
checks the access rights based on the MPU configuration.
diff --git a/docs/partitions/index.rst b/docs/partitions/index.rst
index e43b355..69060af 100644
--- a/docs/partitions/index.rst
+++ b/docs/partitions/index.rst
@@ -2,16 +2,16 @@
==========
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
:titlesonly:
- :hidden:
- Authenticated Debug Access Control <adac/index>
- Delegated Attestation Service Integration Guide <delegated_attestation/delegated_attest_integration_guide>
+ ADAC <adac/adac_integration_guide>
+ Delegated Attestation <delegated_attestation/delegated_attest_integration_guide>
DICE Protection Environmnet <dice_protection_environment>
- DMA-350 Privilege Separation <dma350_unpriv_partition/dma350_privilege_separation>
- Corstone310 Build Steps <dma350_unpriv_partition/dma350_unpriv_partition>
+ DMA-350 ARoT <dma350_unpriv_partition/dma350_unpriv_partition>
External Trusted Secure Storage <external_trusted_secure_storage/external_trusted_secure_storage>
- Measured Boot Service Integration Guide <measured_boot_integration_guide>
+ Measured Boot <measured_boot_integration_guide>
+
+--------------
.. include:: partitions.rst
diff --git a/docs/partitions/partitions.rst b/docs/partitions/partitions.rst
index 27ed042..c6bde50 100644
--- a/docs/partitions/partitions.rst
+++ b/docs/partitions/partitions.rst
@@ -1,18 +1,18 @@
The list and simple introduction of 3rd-party Secure Partitions in this folder.
-**********************
-dma350_upriv_partition
-**********************
+*******
+DMA-350
+*******
DMA-350 Example unprivileged partition
**Maintainers**
-- Bence Balogh `<bence.balogh@arm.com> <bence.balogh@arm.com>`_
-- Mark Horvath `<mark.horvath@arm.com> <mark.horvath@arm.com>`_
+- Bence Balogh `bence.balogh@arm.com <bence.balogh@arm.com>`_
+- Mark Horvath `mark.horvath@arm.com <mark.horvath@arm.com>`_
*************
-measured_boot
+Measured Boot
*************
Measured boot partition for extending and retrieving software component
@@ -20,27 +20,23 @@
**Maintainers**
-- Maulik Patel `<Maulik.Patel@arm.com>`_
-- David Vincze `<David.Vincze@arm.com>`_
+- Maulik Patel `Maulik.Patel@arm.com <Maulik.Patel@arm.com>`_
+- David Vincze `David.Vincze@arm.com <David.Vincze@arm.com>`_
*******************************
-external_trusted_secure_storage
+External Trusted Secure Storage
*******************************
ETSS partition for providing external trusted secure storage services
to protect assets stored in external secure Flash from a variety of
-security attacks.
+security attacks. Avaialble from **TF-M v1.4.0**
**Maintainers**
-- Poppy Wu `<poppywu@mxic.com.cn>`_
-
-**TF-M version**
-
-TF-M V1.4.0
+- Poppy Wu `poppywu@mxic.com.cn <poppywu@mxic.com.cn>`_
*********************
-delegated_attestation
+Delegated Attestation
*********************
The aim of the partition is to support platforms/systems using a delegated
@@ -49,11 +45,11 @@
**Maintainers**
-- David Vincze `<David.Vincze@arm.com>`_
+- David Vincze `David.Vincze@arm.com <David.Vincze@arm.com>`_
-************
-vad_an552_sp
-************
+************************
+Voice Activity Detection
+************************
Secure partition for the AN552 FPGA image. It implements voice activity
detection on the microphone input of the MPS3 board, and if voice detected
@@ -63,22 +59,18 @@
**Maintainers**
-- Gabor Toth `<gabor.toth@arm.com> <gabor.toth@arm.com>`_
-- Mark Horvath `<mark.horvath@arm.com> <mark.horvath@arm.com>`_
+- Gabor Toth `gabor.toth@arm.com <gabor.toth@arm.com>`_
+- Mark Horvath `mark.horvath@arm.com <mark.horvath@arm.com>`_
####
-adac
+ADAC
####
-***********
-Description
-***********
ADAC partition for authenticated debug and access control for RSE platform.
-***********
-Maintainers
-***********
-- Maulik Patel `<Maulik.Patel@arm.com>`_
+**Maintainers**
+
+- Maulik Patel `Maulik.Patel@arm.com <Maulik.Patel@arm.com>`_
---------------------------