aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doxygen/mainpage.dox24
-rw-r--r--interface/dir_interface.dox17
-rw-r--r--secure_fw/core/dir_core.dox16
-rw-r--r--secure_fw/dir_secure_fw.dox17
-rw-r--r--secure_fw/include/dir_include.dox17
-rw-r--r--secure_fw/ns_callable/dir_ns_callable.dox18
-rw-r--r--secure_fw/services/audit_logging/dir_audit_logging.dox17
-rw-r--r--secure_fw/services/crypto/dir_crypto.dox16
-rw-r--r--secure_fw/services/dir_services.dox18
-rw-r--r--secure_fw/services/initial_attestation/dir_initial_attestation.dox17
-rw-r--r--secure_fw/services/platform/dir_platform.dox16
-rw-r--r--secure_fw/services/secure_storage/dir_secure_storage.dox17
-rw-r--r--secure_fw/spm/dir_spm.dox16
-rw-r--r--test/dir_test.dox17
14 files changed, 243 insertions, 0 deletions
diff --git a/doxygen/mainpage.dox b/doxygen/mainpage.dox
new file mode 100644
index 0000000000..e552f8faaf
--- /dev/null
+++ b/doxygen/mainpage.dox
@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file is the main page for the Doxygen based reference guide.
+
+/*!
+\mainpage TF-M Reference Manual
+
+This document gives a reference for the TF-M core and services. This guide does
+not cover the non-secure application example, the boot-loader and the target
+platform implementations.
+
+\htmlonly
+Please use the menu on the left or on the top of the page for navigation.
+
+If information of a specific item is needed, then please use the search box
+top-right.
+\endhtmlonly
+
+*/
diff --git a/interface/dir_interface.dox b/interface/dir_interface.dox
new file mode 100644
index 0000000000..2ddef823e5
--- /dev/null
+++ b/interface/dir_interface.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code defining secure domain entry points for the non-secure
+domain.
+\details
+
+*/ \ No newline at end of file
diff --git a/secure_fw/core/dir_core.dox b/secure_fw/core/dir_core.dox
new file mode 100644
index 0000000000..a8da84823b
--- /dev/null
+++ b/secure_fw/core/dir_core.dox
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the TF-M core.
+\details This directory holds the source code of the "TF-M core" module.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/dir_secure_fw.dox b/secure_fw/dir_secure_fw.dox
new file mode 100644
index 0000000000..df4dbc2ef6
--- /dev/null
+++ b/secure_fw/dir_secure_fw.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the secure side application.
+\details This directory holds the source code of the secure side application.
+This mainly means the TF-M core and the services.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/include/dir_include.dox b/secure_fw/include/dir_include.dox
new file mode 100644
index 0000000000..10d074ff22
--- /dev/null
+++ b/secure_fw/include/dir_include.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Include files for the TF-M.
+\details This directory currently only holds the include file for the SPM
+module.
+
+*/
diff --git a/secure_fw/ns_callable/dir_ns_callable.dox b/secure_fw/ns_callable/dir_ns_callable.dox
new file mode 100644
index 0000000000..d09a913448
--- /dev/null
+++ b/secure_fw/ns_callable/dir_ns_callable.dox
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for veeners callable from the non-secure
+domain.
+\details Each service has a .c file here which implement the entry points for
+service function calls.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/services/audit_logging/dir_audit_logging.dox b/secure_fw/services/audit_logging/dir_audit_logging.dox
new file mode 100644
index 0000000000..68955e902c
--- /dev/null
+++ b/secure_fw/services/audit_logging/dir_audit_logging.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the Audit Logging service.
+\details The audit logging service is responsible for implementing logging
+functionalities which are used to store information on security related events.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/services/crypto/dir_crypto.dox b/secure_fw/services/crypto/dir_crypto.dox
new file mode 100644
index 0000000000..1c7480acd4
--- /dev/null
+++ b/secure_fw/services/crypto/dir_crypto.dox
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the Crypto service.
+\details The Crypto service captures cryptography functionality.
+
+*/
diff --git a/secure_fw/services/dir_services.dox b/secure_fw/services/dir_services.dox
new file mode 100644
index 0000000000..7525e1521e
--- /dev/null
+++ b/secure_fw/services/dir_services.dox
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for secure services.
+\details The source code of each service lives in a sub-directory. In addition
+this directory holds source files defining partitioning information. These are
+generated from the templates in this directory, and partition manifest files.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/services/initial_attestation/dir_initial_attestation.dox b/secure_fw/services/initial_attestation/dir_initial_attestation.dox
new file mode 100644
index 0000000000..e709c8abf5
--- /dev/null
+++ b/secure_fw/services/initial_attestation/dir_initial_attestation.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the initial Attestation service.
+\details The initial Attestation service implements initial attestation
+functionality.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/services/platform/dir_platform.dox b/secure_fw/services/platform/dir_platform.dox
new file mode 100644
index 0000000000..4b25d63296
--- /dev/null
+++ b/secure_fw/services/platform/dir_platform.dox
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the Platform service.
+\details The Platform service captures target platform specific functionality.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/services/secure_storage/dir_secure_storage.dox b/secure_fw/services/secure_storage/dir_secure_storage.dox
new file mode 100644
index 0000000000..036fbce8bd
--- /dev/null
+++ b/secure_fw/services/secure_storage/dir_secure_storage.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the Secure Storage service.
+\details The secure storage service is responsible to hold sensitive information
+in a protected storage.
+
+*/ \ No newline at end of file
diff --git a/secure_fw/spm/dir_spm.dox b/secure_fw/spm/dir_spm.dox
new file mode 100644
index 0000000000..92c8a272e7
--- /dev/null
+++ b/secure_fw/spm/dir_spm.dox
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for the Secure Partition Manager.
+\details This directory holds the source code of the "TF-M SPM" module.
+
+*/ \ No newline at end of file
diff --git a/test/dir_test.dox b/test/dir_test.dox
new file mode 100644
index 0000000000..2ffc86aaa3
--- /dev/null
+++ b/test/dir_test.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code for TF-M tests.
+\details TF-M tests exercise the TF-M core and various services to check correct
+operation.
+
+*/ \ No newline at end of file