Docs: Fix spelling typos
Signed-off-by: Antonio de Angelis <antonio.deangelis@arm.com>
Change-Id: Ie7729b848b7284696d9b546b676cb4f31ab5db47
diff --git a/docs/integration_guide/index.rst b/docs/integration_guide/index.rst
index fbdea54..1923116 100644
--- a/docs/integration_guide/index.rst
+++ b/docs/integration_guide/index.rst
@@ -133,7 +133,7 @@
situation, which can be done by setting
``CONFIG_TFM_SCHEDULE_WHEN_NS_INTERRUPTED`` to 1. This could be done if the
NSPE is known to be a simple, single-threaded application or if non-secure
-interrupts cannot pre-empt the SPE, for example.
+interrupts cannot preempt the SPE, for example.
**********************************
Integration with non-Cmake systems
diff --git a/docs/integration_guide/non-secure_client_extension_integration_guide.rst b/docs/integration_guide/non-secure_client_extension_integration_guide.rst
index c615605..6fd95ed 100644
--- a/docs/integration_guide/non-secure_client_extension_integration_guide.rst
+++ b/docs/integration_guide/non-secure_client_extension_integration_guide.rst
@@ -98,7 +98,7 @@
uint32_t tfm_nsce_acquire_ctx(uint8_t group_id, uint8_t thread_id)
This function allocates a context for the NS client connection. The `gid` and
-`tid` are the input paramemters. A token will be returned to the NSPE if TF-M
+`tid` are the input parameters. A token will be returned to the NSPE if TF-M
has an available context slot. Otherwise, `TFM_NS_CLIENT_INVALID_TOKEN` is
returned.
It is the responsibility of NSPE RTOS to assign gid and tid for each NS client.
@@ -244,7 +244,7 @@
within a group.
- `gid` and `tid` management: It is the responsibility of NSPE RTOS to manage
- the assignment of `gid` and `tid`. Based on the explaination above, the `gid`
+ the assignment of `gid` and `tid`. Based on the explanation above, the `gid`
could be assigned as a constant value. And, the `tid` can be increased
globally when calling `tfm_nsce_acquire_ctx()` for a new task. Just notice
`tid` may overflow.
diff --git a/docs/integration_guide/platform/platform_deprecation.rst b/docs/integration_guide/platform/platform_deprecation.rst
index ef95256..a31824b 100644
--- a/docs/integration_guide/platform/platform_deprecation.rst
+++ b/docs/integration_guide/platform/platform_deprecation.rst
@@ -15,7 +15,7 @@
2. The merit of the proposal will be considered by the maintainers for a
period of 4 weeks and community can express their opinion on the same
during this time window. The platform owner can veto the proposal and
- incase of multiple platform owners with differing opinion or community
+ in case of multiple platform owners with differing opinion or community
having interest in the platform, then the project maintainer can work
with the platform owner and use their discretion to decide on the
proposal.
diff --git a/docs/integration_guide/platform/porting_tfm_to_a_new_hardware.rst b/docs/integration_guide/platform/porting_tfm_to_a_new_hardware.rst
index 177514b..3d7be09 100644
--- a/docs/integration_guide/platform/porting_tfm_to_a_new_hardware.rst
+++ b/docs/integration_guide/platform/porting_tfm_to_a_new_hardware.rst
@@ -11,9 +11,11 @@
*************
Prerequisites
*************
-Building environnement
-======================
-Make sure you have a working build environnement and that you can build
+
+Building environment
+====================
+
+Make sure you have a working build environment and that you can build
TF-M on AN521 following the
:doc:`Build instructions </building/tfm_build_instruction>`.
@@ -24,6 +26,7 @@
CMSIS Drivers
=============
+
The TF-M stack requires at least two CMSIS HAL implementations:
- `USART <https://www.keil.com/pack/doc/CMSIS/Driver/html/group__usart__interface__gr.html>`_
@@ -127,7 +130,7 @@
Please note that platform folder provides source for building both :term:`SPE`
and :term:`NSPE` parts. The SPE builds directly from the source tree while files
necessary for NSPE platform support are installed to ``<Artifact folder>``
-for building TF-M application as decribed in the
+for building TF-M application as described in the
:doc:`Build instructions </building/tfm_build_instruction>`.
Questions to be answered:
@@ -213,7 +216,7 @@
- Install all files required for building the platform in the Non-secure application [INSTALL_]
The installation section expands the common installation script with the platform specific files.
- The following predefined variables are availble to address the respective subfolders
+ The following predefined variables are available to address the respective subfolders
of the target ``<Artifact folder>``.
+-------------------------------------+------------------------------------------------------------+
@@ -262,7 +265,7 @@
+=====================================+============================================================+
|PLATFORM_HAS_ISOLATION_L3_SUPPORT | Whether the platform has isolation level 3 support |
+-------------------------------------+------------------------------------------------------------+
- |PLATFORM_HAS_FIRMWARE_UPDATE_SUPPORT | Wheter the platform has firmware update support |
+ |PLATFORM_HAS_FIRMWARE_UPDATE_SUPPORT | Whether the platform has firmware update support |
+-------------------------------------+------------------------------------------------------------+
|PSA_API_TEST_TARGET | The target platform name of PSA API test |
+-------------------------------------+------------------------------------------------------------+
@@ -406,7 +409,7 @@
from another platform (e.g. arm/mps2/an521) and update the following entries.
General advice: if you don't know beforehand the size you will want for
- these elements you will have to make it iterative from an abitrary value
+ these elements you will have to make it iterative from an arbitrary value
taken from another platform (e.g. arm/mps2/an521)
Note: all size are in bytes
@@ -471,7 +474,7 @@
(location as defined in CMakeLists.txt)
- This is the Run-Time Environnement file from CMSIS, which is there to allow
+ This is the Run-Time Environment file from CMSIS, which is there to allow
enabling or disabling drivers prior to building. If your platform is
designed as a general use platform, this file should contain all the
available CMSIS drivers, and you should provide a recommended configuration.
diff --git a/docs/integration_guide/services/tfm_secure_partition_addition.rst b/docs/integration_guide/services/tfm_secure_partition_addition.rst
index 73cee8e..575b8ff 100644
--- a/docs/integration_guide/services/tfm_secure_partition_addition.rst
+++ b/docs/integration_guide/services/tfm_secure_partition_addition.rst
@@ -92,7 +92,7 @@
.. Note::
The users can use LOW, NORMAL and HIGH to determine the priority of the Secure Partition
- in manifest. They are replaced by 01, 02 and 03 auotmatically when parsing manifest
+ in manifest. They are replaced by 01, 02 and 03 automatically when parsing manifest
lists for section naming.
Here is a manifest reference example for the IPC model:
@@ -452,7 +452,7 @@
.. Note::
The Secure Partition building should be skipped if it is not enabled.
- This should be done by adding the following code at the begining of its ``CMakeLists.txt``
+ This should be done by adding the following code at the beginning of its ``CMakeLists.txt``
.. code-block:: cmake
@@ -747,7 +747,7 @@
``TFM_EXTRA_PARTITION_PATHS``. The orders don't matter either.
``TFM_EXTRA_MANIFEST_LIST_FILES`` and ``TFM_EXTRA_PARTITION_PATHS`` can be
- configurated in multiple extra sources. It is recommended to use CMake list
+ configured in multiple extra sources. It is recommended to use CMake list
``APPEND`` method to avoid unexpected override.
Further Notes
diff --git a/docs/integration_guide/source_structure/source_structure.rst b/docs/integration_guide/source_structure/source_structure.rst
index d7882f4..728b12f 100644
--- a/docs/integration_guide/source_structure/source_structure.rst
+++ b/docs/integration_guide/source_structure/source_structure.rst
@@ -7,7 +7,7 @@
TF-M is designed to provide a user-friendly source structure to ease
integration and service development. This document introduces the source
structure and its design intention of TF-M. Additionally, the folders below are
-important for TF-M integration and descibed in a separate documents:
+important for TF-M integration and described in a separate documents:
.. toctree::
:maxdepth: 1
diff --git a/docs/integration_guide/tfm_fpu_support.rst b/docs/integration_guide/tfm_fpu_support.rst
index 0e1493b..b7bb2c0 100644
--- a/docs/integration_guide/tfm_fpu_support.rst
+++ b/docs/integration_guide/tfm_fpu_support.rst
@@ -59,7 +59,7 @@
linked with ``LINKER_CP_OPTION`` for different FP ABI types. All those
libraries shall be built with ``COMPLIER_CP_FLAG``.
-If FP ABI types mismatch error is generated during build, pleae check whether
+If FP ABI types mismatch error is generated during build, please check whether
the library is compiled with ``COMPILER_CP_FLAG``.
Example:
diff --git a/docs/integration_guide/tfm_secure_irq_integration_guide.rst b/docs/integration_guide/tfm_secure_irq_integration_guide.rst
index 770ff9f..59aafed 100644
--- a/docs/integration_guide/tfm_secure_irq_integration_guide.rst
+++ b/docs/integration_guide/tfm_secure_irq_integration_guide.rst
@@ -10,7 +10,7 @@
are mainly platform integrators and Secure Partition developers.
This document assumes that you have read the PSA Firmware Framework (FF-M) v1.0
-[1]_ and the FF-M v1.1 extensions [2]_ thus have knowlege on the terminologies
+[1]_ and the FF-M v1.1 extensions [2]_ thus have knowledge on the terminologies
such as Secure Partitions and manifests.
************************
@@ -177,7 +177,7 @@
=====================================================
A secure partition shall be granted two parts of permissions to access a device.
-One is the Memory Maped I/O (MMIO) region of the device. The other is the driver
+One is the Memory Mapped I/O (MMIO) region of the device. The other is the driver
codes to access the device.
The MMIO Regions