aboutsummaryrefslogtreecommitdiff
path: root/docs/firmware-design.rst
diff options
context:
space:
mode:
authorDouglas Raillard <douglas.raillard@arm.com>2017-06-28 16:14:55 +0100
committerDouglas Raillard <douglas.raillard@arm.com>2017-06-29 11:48:05 +0100
commit668c5022e5edf6edf36180d04e9ef271829c94b5 (patch)
treeb6f96f94e657f189abb6d1f901b1db20fd827472 /docs/firmware-design.rst
parent6f62574767546b11199142b1b577a86571051c40 (diff)
downloadtrusted-firmware-a-668c5022e5edf6edf36180d04e9ef271829c94b5.tar.gz
Manual fixes to reST documentations
Non-automated fixes to the converted documentation. Change-Id: I61f3d37c7a8d6a56a7351048060b970c5b3751e4 Signed-off-by: Douglas Raillard <douglas.raillard@arm.com>
Diffstat (limited to 'docs/firmware-design.rst')
-rw-r--r--docs/firmware-design.rst21
1 files changed, 9 insertions, 12 deletions
diff --git a/docs/firmware-design.rst b/docs/firmware-design.rst
index cc2fe118d7..f50890b112 100644
--- a/docs/firmware-design.rst
+++ b/docs/firmware-design.rst
@@ -8,22 +8,22 @@ ARM Trusted Firmware Design
.. contents::
The ARM Trusted Firmware implements a subset of the Trusted Board Boot
-Requirements (TBBR) Platform Design Document (PDD) [1] for ARM reference
+Requirements (TBBR) Platform Design Document (PDD) [1]_ for ARM reference
platforms. The TBB sequence starts when the platform is powered on and runs up
to the stage where it hands-off control to firmware running in the normal
world in DRAM. This is the cold boot path.
The ARM Trusted Firmware also implements the Power State Coordination Interface
-PDD [2] as a runtime service. PSCI is the interface from normal world software
+PDD [2]_ as a runtime service. PSCI is the interface from normal world software
to firmware implementing power management use-cases (for example, secondary CPU
boot, hotplug and idle). Normal world software can access ARM Trusted Firmware
runtime services via the ARM SMC (Secure Monitor Call) instruction. The SMC
-instruction must be used as mandated by the SMC Calling Convention [3].
+instruction must be used as mandated by the SMC Calling Convention [3]_.
The ARM Trusted Firmware implements a framework for configuring and managing
interrupts generated in either security state. The details of the interrupt
management framework and its design can be found in ARM Trusted Firmware
-Interrupt Management Design guide [4].
+Interrupt Management Design guide [4]_.
The ARM Trusted Firmware can be built to support either AArch64 or AArch32
execution state.
@@ -2410,14 +2410,11 @@ kernel at boot time. These can be found in the ``fdts`` directory.
References
----------
-#. Trusted Board Boot Requirements CLIENT PDD (ARM DEN 0006B-5). Available
- under NDA through your ARM account representative.
-
-#. `Power State Coordination Interface PDD`_
-
-#. `SMC Calling Convention PDD`_
-
-#. `ARM Trusted Firmware Interrupt Management Design guide`_.
+.. [#] Trusted Board Boot Requirements CLIENT PDD (ARM DEN 0006B-5). Available
+ under NDA through your ARM account representative.
+.. [#] `Power State Coordination Interface PDD`_
+.. [#] `SMC Calling Convention PDD`_
+.. [#] `ARM Trusted Firmware Interrupt Management Design guide`_.
--------------