doc: Update page content after re-arrangement
This patch modifies the content of existing documents now that
it has been moved around. Some of the content requires updating
to make sense in its new location, for example. Other content may
simply be out of date.
Change-Id: I8dfa527e1d1f1520cefd21066802451352b573d2
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>
diff --git a/docs/porting/mandatory-mods.rst b/docs/porting/mandatory-mods.rst
index 4f11324..dd4242f 100644
--- a/docs/porting/mandatory-mods.rst
+++ b/docs/porting/mandatory-mods.rst
@@ -1,8 +1,8 @@
-Mandatory modifications
------------------------
+Mandatory Modifications
+=======================
-File : platform_def.h [mandatory]
-`````````````````````````````````
+File : platform_def.h
+---------------------
Each platform must ensure that a header file of this name is in the system
include path with the following constants defined. This may require updating the
@@ -123,8 +123,8 @@
Defines the largest block size as seen by the software while writing to NOR
flash.
-Function : tftf_plat_arch_setup() [mandatory]
-`````````````````````````````````````````````
+Function : tftf_plat_arch_setup()
+---------------------------------
::
Argument : void
@@ -136,8 +136,8 @@
In both the ARM FVP and Juno ports, this function configures and enables the
MMU.
-Function : tftf_early_platform_setup() [mandatory]
-``````````````````````````````````````````````````
+Function : tftf_early_platform_setup()
+--------------------------------------
::
@@ -150,8 +150,8 @@
In both the ARM FVP and Juno ports, this function configures the console.
-Function : tftf_platform_setup() [mandatory]
-````````````````````````````````````````````
+Function : tftf_platform_setup()
+--------------------------------
::
@@ -167,8 +167,8 @@
also initialises the GIC and detects the platform topology using
platform-specific means.
-Function : plat_get_nvm_handle() [mandatory]
-````````````````````````````````````````````
+Function : plat_get_nvm_handle()
+--------------------------------
::
@@ -179,8 +179,8 @@
responsible for getting the pointer to the initialised non-volatile memory
entity.
-Function : tftf_plat_get_pwr_domain_tree_desc() [mandatory]
-```````````````````````````````````````````````````````````
+Function : tftf_plat_get_pwr_domain_tree_desc()
+-----------------------------------------------
::
@@ -204,8 +204,8 @@
details of its description can be found in the Trusted Firmware-A documentation:
`docs/psci-pd-tree.rst`_.
-Function : tftf_plat_get_mpidr() [mandatory]
-````````````````````````````````````````````
+Function : tftf_plat_get_mpidr()
+--------------------------------
::
@@ -220,8 +220,8 @@
referred to by the `core_pos` is absent, then this function returns
``INVALID_MPID``.
-Function : plat_get_state_prop() [mandatory]
-````````````````````````````````````````````
+Function : plat_get_state_prop()
+--------------------------------
::
@@ -235,8 +235,8 @@
state parameter for use in ``PSCI_CPU_SUSPEND`` API or ``PSCI_STAT/RESIDENCY``
API.
-Function : plat_fwu_io_setup() [mandatory]
-``````````````````````````````````````````
+Function : plat_fwu_io_setup()
+------------------------------
::
@@ -245,8 +245,8 @@
This function initializes the IO system used by the firmware update.
-Function : plat_arm_gic_init() [mandatory]
-``````````````````````````````````````````
+Function : plat_arm_gic_init()
+------------------------------
::
@@ -255,8 +255,8 @@
This function initializes the ARM Generic Interrupt Controller (GIC).
-Function : platform_get_core_pos() [mandatory]
-``````````````````````````````````````````````
+Function : platform_get_core_pos()
+----------------------------------
::
@@ -265,8 +265,8 @@
This function returns a linear core ID from a MPID.
-Function : plat_crash_console_init() [mandatory]
-````````````````````````````````````````````````
+Function : plat_crash_console_init()
+------------------------------------
::
@@ -275,8 +275,8 @@
This function initializes a platform-specific console for crash reporting.
-Function : plat_crash_console_putc() [mandatory]
-````````````````````````````````````````````````
+Function : plat_crash_console_putc()
+------------------------------------
::
@@ -285,8 +285,8 @@
This function prints a character on the platform-specific crash console.
-Function : plat_crash_console_flush() [mandatory]
-`````````````````````````````````````````````````
+Function : plat_crash_console_flush()
+-------------------------------------
::
diff --git a/docs/porting/optional-mods.rst b/docs/porting/optional-mods.rst
index 8bee341..a88d682 100644
--- a/docs/porting/optional-mods.rst
+++ b/docs/porting/optional-mods.rst
@@ -1,4 +1,4 @@
-Optional modifications
+Optional Modifications
======================
The following are helper functions implemented by the test framework that
@@ -6,7 +6,7 @@
definitions.
Function : platform_get_stack()
-```````````````````````````````
+-------------------------------
::
@@ -21,7 +21,7 @@
``plat/common/aarch64/platform_mp_stack.S``.
Function : tftf_platform_end()
-``````````````````````````````
+------------------------------
::
@@ -37,7 +37,7 @@
this character and rebooting the platform for example.
Function : tftf_plat_reset()
-````````````````````````````
+----------------------------
::
diff --git a/docs/porting/requirements.rst b/docs/porting/requirements.rst
index 158b4b8..0a00592 100644
--- a/docs/porting/requirements.rst
+++ b/docs/porting/requirements.rst
@@ -1,4 +1,4 @@
-Platform requirements
+Platform Requirements
=====================
The TF-A Tests rely on the following features to be present on the platform and
diff --git a/docs/porting/storage.rst b/docs/porting/storage.rst
index 6074358..1317e7d 100644
--- a/docs/porting/storage.rst
+++ b/docs/porting/storage.rst
@@ -1,17 +1,21 @@
-Storage abstraction layer
+Storage Abstraction Layer
=========================
In order to improve platform independence and portability a storage abstraction
layer is used to store test results to non-volatile platform storage.
-Each platform should register devices and their drivers via the Storage layer.
-These drivers then need to be initialized in ``tftf_platform_setup()`` function.
+Each platform should register devices and their drivers via the storage layer.
+These drivers then need to be initialized using the ``tftf_platform_setup()``
+function.
-It is mandatory to implement at least one storage driver. For the FVP and Juno
-platforms the NOR Flash driver is provided as the default means to store test
-results to storage. The storage layer is described in the header file
-``include/lib/io_storage.h``. The implementation of the common library is in
-``drivers/io/io_storage.c`` and the driver files are located in ``drivers/io/``.
+.. warning::
+ It is mandatory to implement at least one storage driver.
+
+For the FVP and Juno platforms the NOR Flash driver is provided as the default
+means to store test results to storage. The storage layer is described in the
+header file ``include/lib/io_storage.h``. The implementation of the common
+library is in ``drivers/io/io_storage.c`` and the driver files are located in
+``drivers/io/``.
--------------