aboutsummaryrefslogtreecommitdiffstats
path: root/docs/user-guide.rst
diff options
context:
space:
mode:
authorAntonio Nino Diaz <antonio.ninodiaz@arm.com>2017-05-23 11:49:22 +0100
committerSandrine Bailleux <sandrine.bailleux@arm.com>2017-08-08 16:49:47 +0100
commit6feb9e8854cbe551113d167cda5a275663196e0a (patch)
tree2773dd988e62321a4573d66481275652c5eba2b4 /docs/user-guide.rst
parent2f860c7815c648393f0604c872d5b39546da6419 (diff)
downloadplatform_external_arm-trusted-firmware-6feb9e8854cbe551113d167cda5a275663196e0a.tar.gz
platform_external_arm-trusted-firmware-6feb9e8854cbe551113d167cda5a275663196e0a.tar.bz2
platform_external_arm-trusted-firmware-6feb9e8854cbe551113d167cda5a275663196e0a.zip
Add documentation of the xlat tables library V2
The documentation describes the design of the translation tables library version 2 used by the ARM Trusted Firmware. The diagram file has been created with Dia version 0.97.2. This tool can be obtained from: https://wiki.gnome.org/Apps/Dia/Download Inkscape has been used to generate the *.png file from the *.dia file to work around a bug in the generation of *.png files in some versions of Dia. Change-Id: Ie67d9998d4ae881b2c060200a318ad3ac2fa5e91 Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com> Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Diffstat (limited to 'docs/user-guide.rst')
-rw-r--r--docs/user-guide.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index ec8c2333e..f58c8db08 100644
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -73,6 +73,10 @@ In addition, the following optional packages and tools may be needed:
- For debugging, ARM `Development Studio 5 (DS-5)`_.
+- To create and modify the diagram files included in the documentation, `Dia`_.
+ This tool can be found in most Linux distributions. Inkscape is needed to
+ generate the actual *.png files.
+
Getting the Trusted Firmware source code
----------------------------------------
@@ -1739,6 +1743,7 @@ wakeup interrupt from RTC.
.. _Instructions for using Linaro's deliverables on Juno: https://community.arm.com/dev-platforms/b/documents/posts/using-linaros-deliverables-on-juno
.. _ARM Platforms Portal: https://community.arm.com/dev-platforms/
.. _Development Studio 5 (DS-5): http://www.arm.com/products/tools/software-tools/ds-5/index.php
+.. _Dia: https://wiki.gnome.org/Apps/Dia/Download
.. _here: psci-lib-integration-guide.rst
.. _Trusted Board Boot: trusted-board-boot.rst
.. _Secure-EL1 Payloads and Dispatchers: firmware-design.rst#user-content-secure-el1-payloads-and-dispatchers