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()
+-------------------------------------
::