aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Beesley <paul.beesley@arm.com>2019-03-13 15:49:27 +0000
committerPaul Beesley <paul.beesley@arm.com>2019-05-22 11:28:17 +0100
commita2c320a83ef3966b30929636fb8345a7eabee2ae (patch)
treeef63058c61e521b6851637d267ead1416dbf3fb2
parent29c02529592fb2489edee6c92e418918e5732105 (diff)
doc: Reorganise images and update links
Change-Id: I679d1499376a524bef1cfc33df995b0a719b5ac8 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
-rw-r--r--docs/components/exception-handling.rst2
-rw-r--r--docs/components/firmware-update.rst4
-rw-r--r--docs/components/ras.rst2
-rw-r--r--docs/components/romlib-design.rst4
-rw-r--r--docs/components/sdei.rst4
-rw-r--r--docs/components/secure-partition-manager-design.rst4
-rw-r--r--docs/components/xlat-tables-lib-v2-design.rst2
-rw-r--r--docs/design/firmware-design.rst2
-rw-r--r--docs/design/interrupt-framework-design.rst4
-rw-r--r--docs/design/reset-design.rst8
-rw-r--r--docs/resources/diagrams/Makefile (renamed from docs/diagrams/Makefile)0
-rw-r--r--docs/resources/diagrams/default_reset_code.png (renamed from docs/diagrams/default_reset_code.png)bin41796 -> 41796 bytes
-rw-r--r--docs/resources/diagrams/draw.io/ehf.svg (renamed from docs/draw.io/ehf.svg)0
-rw-r--r--docs/resources/diagrams/draw.io/ehf.xml (renamed from docs/draw.io/ehf.xml)0
-rw-r--r--docs/resources/diagrams/draw.io/ras.svg (renamed from docs/draw.io/ras.svg)0
-rw-r--r--docs/resources/diagrams/draw.io/ras.xml (renamed from docs/draw.io/ras.xml)0
-rw-r--r--docs/resources/diagrams/fwu_flow.png (renamed from docs/diagrams/fwu_flow.png)bin167225 -> 167225 bytes
-rw-r--r--docs/resources/diagrams/fwu_states.png (renamed from docs/diagrams/fwu_states.png)bin114222 -> 114222 bytes
-rw-r--r--docs/resources/diagrams/int_handling.dia (renamed from docs/diagrams/int_handling.dia)bin10623 -> 10623 bytes
-rw-r--r--docs/resources/diagrams/non-sec-int-handling.png (renamed from docs/diagrams/non-sec-int-handling.png)bin218768 -> 218768 bytes
-rw-r--r--[-rwxr-xr-x]docs/resources/diagrams/plantuml/plantuml_to_svg.sh (renamed from docs/plantuml/plantuml_to_svg.sh)0
-rw-r--r--docs/resources/diagrams/plantuml/sdei_explicit_dispatch.puml (renamed from docs/plantuml/sdei_explicit_dispatch.puml)0
-rw-r--r--docs/resources/diagrams/plantuml/sdei_explicit_dispatch.svg (renamed from docs/plantuml/sdei_explicit_dispatch.svg)0
-rw-r--r--docs/resources/diagrams/plantuml/sdei_general.puml (renamed from docs/plantuml/sdei_general.puml)0
-rw-r--r--docs/resources/diagrams/plantuml/sdei_general.svg (renamed from docs/plantuml/sdei_general.svg)0
-rw-r--r--docs/resources/diagrams/psci-suspend-sequence.png (renamed from docs/diagrams/psci-suspend-sequence.png)bin427800 -> 427800 bytes
-rw-r--r--docs/resources/diagrams/reset_code_flow.dia (renamed from docs/diagrams/reset_code_flow.dia)bin4399 -> 4399 bytes
-rw-r--r--docs/resources/diagrams/reset_code_no_boot_type_check.png (renamed from docs/diagrams/reset_code_no_boot_type_check.png)bin42942 -> 42942 bytes
-rw-r--r--docs/resources/diagrams/reset_code_no_checks.png (renamed from docs/diagrams/reset_code_no_checks.png)bin39753 -> 39753 bytes
-rw-r--r--docs/resources/diagrams/reset_code_no_cpu_check.png (renamed from docs/diagrams/reset_code_no_cpu_check.png)bin38566 -> 38566 bytes
-rw-r--r--[-rwxr-xr-x]docs/resources/diagrams/romlib_design.dia (renamed from docs/diagrams/romlib_design.dia)bin2985 -> 2985 bytes
-rw-r--r--[-rwxr-xr-x]docs/resources/diagrams/romlib_design.png (renamed from docs/diagrams/romlib_design.png)bin17244 -> 17244 bytes
-rw-r--r--[-rwxr-xr-x]docs/resources/diagrams/romlib_wrapper.dia (renamed from docs/diagrams/romlib_wrapper.dia)bin2543 -> 2543 bytes
-rw-r--r--[-rwxr-xr-x]docs/resources/diagrams/romlib_wrapper.png (renamed from docs/diagrams/romlib_wrapper.png)bin12085 -> 12085 bytes
-rw-r--r--docs/resources/diagrams/rt-svc-descs-layout.png (renamed from docs/diagrams/rt-svc-descs-layout.png)bin77894 -> 77894 bytes
-rw-r--r--docs/resources/diagrams/sec-int-handling.png (renamed from docs/diagrams/sec-int-handling.png)bin173315 -> 173315 bytes
-rw-r--r--docs/resources/diagrams/secure_sw_stack_sp.png (renamed from docs/diagrams/secure_sw_stack_sp.png)bin34909 -> 34909 bytes
-rw-r--r--docs/resources/diagrams/secure_sw_stack_tos.png (renamed from docs/diagrams/secure_sw_stack_tos.png)bin34202 -> 34202 bytes
-rw-r--r--docs/resources/diagrams/xlat_align.dia (renamed from docs/diagrams/xlat_align.dia)bin2346 -> 2346 bytes
-rw-r--r--docs/resources/diagrams/xlat_align.png (renamed from docs/diagrams/xlat_align.png)bin46712 -> 46712 bytes
40 files changed, 18 insertions, 18 deletions
diff --git a/docs/components/exception-handling.rst b/docs/components/exception-handling.rst
index a89a05c9..30600f95 100644
--- a/docs/components/exception-handling.rst
+++ b/docs/components/exception-handling.rst
@@ -107,7 +107,7 @@ for more than one priority level.
.. _ehf-figure:
-.. image:: ../draw.io/ehf.svg
+.. image:: ../resources/diagrams/draw.io/ehf.svg
A priority level is *active* when a handler at that priority level is currently
executing in EL3, or has delegated the execution to a lower EL. For interrupts,
diff --git a/docs/components/firmware-update.rst b/docs/components/firmware-update.rst
index 608803d5..31f5917e 100644
--- a/docs/components/firmware-update.rst
+++ b/docs/components/firmware-update.rst
@@ -400,5 +400,5 @@ This is only allowed if the image is not being executed.
.. _Authentication Framework Design: ./auth-framework.rst
.. _Universally Unique Identifier: https://tools.ietf.org/rfc/rfc4122.txt
-.. |Flow Diagram| image:: diagrams/fwu_flow.png?raw=true
-.. |FWU state machine| image:: diagrams/fwu_states.png?raw=true
+.. |Flow Diagram| image:: ../resources/diagrams/fwu_flow.png
+.. |FWU state machine| image:: ../resources/diagrams/fwu_states.png
diff --git a/docs/components/ras.rst b/docs/components/ras.rst
index 9d56e63a..137c0c30 100644
--- a/docs/components/ras.rst
+++ b/docs/components/ras.rst
@@ -39,7 +39,7 @@ be set ``1``.
.. _ras-figure:
-.. image:: ../draw.io/ras.svg
+.. image:: ../resources/diagrams/draw.io/ras.svg
See more on `Engaging the RAS framework`_.
diff --git a/docs/components/romlib-design.rst b/docs/components/romlib-design.rst
index ab39723f..a70ed17f 100644
--- a/docs/components/romlib-design.rst
+++ b/docs/components/romlib-design.rst
@@ -23,7 +23,7 @@ are placed in ROM. The capabilities of the "library at ROM" are:
Index file
~~~~~~~~~~
-.. image:: diagrams/romlib_design.png
+.. image:: ../resources/diagrams/romlib_design.png
:width: 600
Library at ROM is described by an index file with the list of functions to be
@@ -54,7 +54,7 @@ For an index file example, refer to ``lib/romlib/jmptbl.i``.
Wrapper functions
~~~~~~~~~~~~~~~~~
-.. image:: diagrams/romlib_wrapper.png
+.. image:: ../resources/diagrams/romlib_wrapper.png
:width: 600
When invoking a function of the "library at ROM", the calling sequence is as
diff --git a/docs/components/sdei.rst b/docs/components/sdei.rst
index 7b6cc913..845a2955 100644
--- a/docs/components/sdei.rst
+++ b/docs/components/sdei.rst
@@ -26,7 +26,7 @@ The following figure depicts a general sequence involving SDEI client executing
at EL2 and an event dispatch resulting from the triggering of a bound interrupt.
A commentary is provided below:
-.. image:: ../plantuml/sdei_general.svg
+.. image:: ../resources/diagrams/plantuml/sdei_general.svg
As part of initialisation, the SDEI client binds a Non-secure interrupt [1], and
the SDEI dispatcher returns a platform dynamic event number [2]. The client then
@@ -234,7 +234,7 @@ on success, or ``-1`` on failure.
The following figure depicts a scenario involving explicit dispatch of SDEI
event. A commentary is provided below:
-.. image:: ../plantuml/sdei_explicit_dispatch.svg
+.. image:: ../resources/diagrams/plantuml/sdei_explicit_dispatch.svg
As part of initialisation, the SDEI client registers a handler for a platform
event [1], enables the event [3], and unmasks the current PE [5]. Note that,
diff --git a/docs/components/secure-partition-manager-design.rst b/docs/components/secure-partition-manager-design.rst
index 88052c55..ac1172c8 100644
--- a/docs/components/secure-partition-manager-design.rst
+++ b/docs/components/secure-partition-manager-design.rst
@@ -814,5 +814,5 @@ Error Codes
.. _SDEI Specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf
.. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf
-.. |Image 1| image:: ../diagrams/secure_sw_stack_tos.png
-.. |Image 2| image:: ../diagrams/secure_sw_stack_sp.png
+.. |Image 1| image:: ../resources/diagrams/secure_sw_stack_tos.png
+.. |Image 2| image:: ../resources/diagrams/secure_sw_stack_sp.png
diff --git a/docs/components/xlat-tables-lib-v2-design.rst b/docs/components/xlat-tables-lib-v2-design.rst
index a78d3511..786dd3bc 100644
--- a/docs/components/xlat-tables-lib-v2-design.rst
+++ b/docs/components/xlat-tables-lib-v2-design.rst
@@ -418,4 +418,4 @@ mapping cannot be cached in the TLBs.
.. _aarch32/xlat_tables_arch.c: ../../lib/xlat_tables_v2/aarch32/xlat_tables_arch.c
.. _aarch64/xlat_tables_arch.c: ../../lib/xlat_tables_v2/aarch64/xlat_tables_arch.c
.. _Porting Guide: ../getting_started/porting-guide.rst
-.. |Alignment Example| image:: ../diagrams/xlat_align.png?raw=true
+.. |Alignment Example| image:: ../resources/diagrams/xlat_align.png
diff --git a/docs/design/firmware-design.rst b/docs/design/firmware-design.rst
index e9384e62..710d26de 100644
--- a/docs/design/firmware-design.rst
+++ b/docs/design/firmware-design.rst
@@ -2679,4 +2679,4 @@ References
.. _ROMLIB Design: romlib-design.rst
.. _Trusted Board Boot Requirements CLIENT (TBBR-CLIENT) Armv8-A (ARM DEN0006D): https://developer.arm.com/docs/den0006/latest/trusted-board-boot-requirements-client-tbbr-client-armv8-a
-.. |Image 1| image:: diagrams/rt-svc-descs-layout.png?raw=true
+.. |Image 1| image:: ../resources/diagrams/rt-svc-descs-layout.png
diff --git a/docs/design/interrupt-framework-design.rst b/docs/design/interrupt-framework-design.rst
index d4057ea4..b19f7f73 100644
--- a/docs/design/interrupt-framework-design.rst
+++ b/docs/design/interrupt-framework-design.rst
@@ -1015,5 +1015,5 @@ TSP by returning ``SMC_UNK`` error.
.. _Porting Guide: ../getting_started/porting-guide.rst
.. _SMC calling convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html
-.. |Image 1| image:: diagrams/sec-int-handling.png?raw=true
-.. |Image 2| image:: diagrams/non-sec-int-handling.png?raw=true
+.. |Image 1| image:: ../resources/diagrams/sec-int-handling.png
+.. |Image 2| image:: ../resources/diagrams/non-sec-int-handling.png
diff --git a/docs/design/reset-design.rst b/docs/design/reset-design.rst
index c38f6274..b5c9bb41 100644
--- a/docs/design/reset-design.rst
+++ b/docs/design/reset-design.rst
@@ -154,7 +154,7 @@ This might be done by the Trusted Boot Firmware or by platform code in BL31.
.. _Firmware Design: firmware-design.rst
.. _User Guide: ../getting_started/user-guide.rst
-.. |Default reset code flow| image:: ../diagrams/default_reset_code.png?raw=true
-.. |Reset code flow with programmable reset address| image:: ../diagrams/reset_code_no_boot_type_check.png?raw=true
-.. |Reset code flow with single CPU released out of reset| image:: ../diagrams/reset_code_no_cpu_check.png?raw=true
-.. |Reset code flow with programmable reset address and single CPU released out of reset| image:: ../diagrams/reset_code_no_checks.png?raw=true
+.. |Default reset code flow| image:: ../resources/diagrams/default_reset_code.png
+.. |Reset code flow with programmable reset address| image:: ../resources/diagrams/reset_code_no_boot_type_check.png
+.. |Reset code flow with single CPU released out of reset| image:: ../resources/diagrams/reset_code_no_cpu_check.png
+.. |Reset code flow with programmable reset address and single CPU released out of reset| image:: ../resources/diagrams/reset_code_no_checks.png
diff --git a/docs/diagrams/Makefile b/docs/resources/diagrams/Makefile
index de7d8f3f..de7d8f3f 100644
--- a/docs/diagrams/Makefile
+++ b/docs/resources/diagrams/Makefile
diff --git a/docs/diagrams/default_reset_code.png b/docs/resources/diagrams/default_reset_code.png
index d8675e4a..d8675e4a 100644
--- a/docs/diagrams/default_reset_code.png
+++ b/docs/resources/diagrams/default_reset_code.png
Binary files differ
diff --git a/docs/draw.io/ehf.svg b/docs/resources/diagrams/draw.io/ehf.svg
index c98090f3..c98090f3 100644
--- a/docs/draw.io/ehf.svg
+++ b/docs/resources/diagrams/draw.io/ehf.svg
diff --git a/docs/draw.io/ehf.xml b/docs/resources/diagrams/draw.io/ehf.xml
index db1f91d3..db1f91d3 100644
--- a/docs/draw.io/ehf.xml
+++ b/docs/resources/diagrams/draw.io/ehf.xml
diff --git a/docs/draw.io/ras.svg b/docs/resources/diagrams/draw.io/ras.svg
index ff581982..ff581982 100644
--- a/docs/draw.io/ras.svg
+++ b/docs/resources/diagrams/draw.io/ras.svg
diff --git a/docs/draw.io/ras.xml b/docs/resources/diagrams/draw.io/ras.xml
index ce6df3a6..ce6df3a6 100644
--- a/docs/draw.io/ras.xml
+++ b/docs/resources/diagrams/draw.io/ras.xml
diff --git a/docs/diagrams/fwu_flow.png b/docs/resources/diagrams/fwu_flow.png
index 534095f5..534095f5 100644
--- a/docs/diagrams/fwu_flow.png
+++ b/docs/resources/diagrams/fwu_flow.png
Binary files differ
diff --git a/docs/diagrams/fwu_states.png b/docs/resources/diagrams/fwu_states.png
index fda4d8fd..fda4d8fd 100644
--- a/docs/diagrams/fwu_states.png
+++ b/docs/resources/diagrams/fwu_states.png
Binary files differ
diff --git a/docs/diagrams/int_handling.dia b/docs/resources/diagrams/int_handling.dia
index 12aa186c..12aa186c 100644
--- a/docs/diagrams/int_handling.dia
+++ b/docs/resources/diagrams/int_handling.dia
Binary files differ
diff --git a/docs/diagrams/non-sec-int-handling.png b/docs/resources/diagrams/non-sec-int-handling.png
index 64082c95..64082c95 100644
--- a/docs/diagrams/non-sec-int-handling.png
+++ b/docs/resources/diagrams/non-sec-int-handling.png
Binary files differ
diff --git a/docs/plantuml/plantuml_to_svg.sh b/docs/resources/diagrams/plantuml/plantuml_to_svg.sh
index 0bf8588b..0bf8588b 100755..100644
--- a/docs/plantuml/plantuml_to_svg.sh
+++ b/docs/resources/diagrams/plantuml/plantuml_to_svg.sh
diff --git a/docs/plantuml/sdei_explicit_dispatch.puml b/docs/resources/diagrams/plantuml/sdei_explicit_dispatch.puml
index 90ff23cc..90ff23cc 100644
--- a/docs/plantuml/sdei_explicit_dispatch.puml
+++ b/docs/resources/diagrams/plantuml/sdei_explicit_dispatch.puml
diff --git a/docs/plantuml/sdei_explicit_dispatch.svg b/docs/resources/diagrams/plantuml/sdei_explicit_dispatch.svg
index e12cae2f..e12cae2f 100644
--- a/docs/plantuml/sdei_explicit_dispatch.svg
+++ b/docs/resources/diagrams/plantuml/sdei_explicit_dispatch.svg
diff --git a/docs/plantuml/sdei_general.puml b/docs/resources/diagrams/plantuml/sdei_general.puml
index ab6929ab..ab6929ab 100644
--- a/docs/plantuml/sdei_general.puml
+++ b/docs/resources/diagrams/plantuml/sdei_general.puml
diff --git a/docs/plantuml/sdei_general.svg b/docs/resources/diagrams/plantuml/sdei_general.svg
index e1721122..e1721122 100644
--- a/docs/plantuml/sdei_general.svg
+++ b/docs/resources/diagrams/plantuml/sdei_general.svg
diff --git a/docs/diagrams/psci-suspend-sequence.png b/docs/resources/diagrams/psci-suspend-sequence.png
index 1703ea68..1703ea68 100644
--- a/docs/diagrams/psci-suspend-sequence.png
+++ b/docs/resources/diagrams/psci-suspend-sequence.png
Binary files differ
diff --git a/docs/diagrams/reset_code_flow.dia b/docs/resources/diagrams/reset_code_flow.dia
index 133c9cf6..133c9cf6 100644
--- a/docs/diagrams/reset_code_flow.dia
+++ b/docs/resources/diagrams/reset_code_flow.dia
Binary files differ
diff --git a/docs/diagrams/reset_code_no_boot_type_check.png b/docs/resources/diagrams/reset_code_no_boot_type_check.png
index 23e865f6..23e865f6 100644
--- a/docs/diagrams/reset_code_no_boot_type_check.png
+++ b/docs/resources/diagrams/reset_code_no_boot_type_check.png
Binary files differ
diff --git a/docs/diagrams/reset_code_no_checks.png b/docs/resources/diagrams/reset_code_no_checks.png
index 26a179bc..26a179bc 100644
--- a/docs/diagrams/reset_code_no_checks.png
+++ b/docs/resources/diagrams/reset_code_no_checks.png
Binary files differ
diff --git a/docs/diagrams/reset_code_no_cpu_check.png b/docs/resources/diagrams/reset_code_no_cpu_check.png
index 4150dbef..4150dbef 100644
--- a/docs/diagrams/reset_code_no_cpu_check.png
+++ b/docs/resources/diagrams/reset_code_no_cpu_check.png
Binary files differ
diff --git a/docs/diagrams/romlib_design.dia b/docs/resources/diagrams/romlib_design.dia
index d12eec07..d12eec07 100755..100644
--- a/docs/diagrams/romlib_design.dia
+++ b/docs/resources/diagrams/romlib_design.dia
Binary files differ
diff --git a/docs/diagrams/romlib_design.png b/docs/resources/diagrams/romlib_design.png
index bfffcde7..bfffcde7 100755..100644
--- a/docs/diagrams/romlib_design.png
+++ b/docs/resources/diagrams/romlib_design.png
Binary files differ
diff --git a/docs/diagrams/romlib_wrapper.dia b/docs/resources/diagrams/romlib_wrapper.dia
index 30cfbd80..30cfbd80 100755..100644
--- a/docs/diagrams/romlib_wrapper.dia
+++ b/docs/resources/diagrams/romlib_wrapper.dia
Binary files differ
diff --git a/docs/diagrams/romlib_wrapper.png b/docs/resources/diagrams/romlib_wrapper.png
index ec3a4411..ec3a4411 100755..100644
--- a/docs/diagrams/romlib_wrapper.png
+++ b/docs/resources/diagrams/romlib_wrapper.png
Binary files differ
diff --git a/docs/diagrams/rt-svc-descs-layout.png b/docs/resources/diagrams/rt-svc-descs-layout.png
index 1a9fa5b0..1a9fa5b0 100644
--- a/docs/diagrams/rt-svc-descs-layout.png
+++ b/docs/resources/diagrams/rt-svc-descs-layout.png
Binary files differ
diff --git a/docs/diagrams/sec-int-handling.png b/docs/resources/diagrams/sec-int-handling.png
index fa5c340a..fa5c340a 100644
--- a/docs/diagrams/sec-int-handling.png
+++ b/docs/resources/diagrams/sec-int-handling.png
Binary files differ
diff --git a/docs/diagrams/secure_sw_stack_sp.png b/docs/resources/diagrams/secure_sw_stack_sp.png
index 5cb2ca7a..5cb2ca7a 100644
--- a/docs/diagrams/secure_sw_stack_sp.png
+++ b/docs/resources/diagrams/secure_sw_stack_sp.png
Binary files differ
diff --git a/docs/diagrams/secure_sw_stack_tos.png b/docs/resources/diagrams/secure_sw_stack_tos.png
index 1f2d5550..1f2d5550 100644
--- a/docs/diagrams/secure_sw_stack_tos.png
+++ b/docs/resources/diagrams/secure_sw_stack_tos.png
Binary files differ
diff --git a/docs/diagrams/xlat_align.dia b/docs/resources/diagrams/xlat_align.dia
index bd88c0cc..bd88c0cc 100644
--- a/docs/diagrams/xlat_align.dia
+++ b/docs/resources/diagrams/xlat_align.dia
Binary files differ
diff --git a/docs/diagrams/xlat_align.png b/docs/resources/diagrams/xlat_align.png
index cffd3c19..cffd3c19 100644
--- a/docs/diagrams/xlat_align.png
+++ b/docs/resources/diagrams/xlat_align.png
Binary files differ