From a2c320a83ef3966b30929636fb8345a7eabee2ae Mon Sep 17 00:00:00 2001
From: Paul Beesley <paul.beesley@arm.com>
Date: Wed, 13 Mar 2019 15:49:27 +0000
Subject: [PATCH] doc: Reorganise images and update links
Change-Id: I679d1499376a524bef1cfc33df995b0a719b5ac8
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
---
docs/components/exception-handling.rst | 2 +-
docs/components/firmware-update.rst | 4 ++--
docs/components/ras.rst | 2 +-
docs/components/romlib-design.rst | 4 ++--
docs/components/sdei.rst | 4 ++--
docs/components/secure-partition-manager-design.rst | 4 ++--
docs/components/xlat-tables-lib-v2-design.rst | 2 +-
docs/design/firmware-design.rst | 2 +-
docs/design/interrupt-framework-design.rst | 4 ++--
docs/design/reset-design.rst | 8 ++++----
docs/{ => resources}/diagrams/Makefile | 0
.../{ => resources}/diagrams/default_reset_code.png | Bin
docs/{ => resources/diagrams}/draw.io/ehf.svg | 0
docs/{ => resources/diagrams}/draw.io/ehf.xml | 0
docs/{ => resources/diagrams}/draw.io/ras.svg | 0
docs/{ => resources/diagrams}/draw.io/ras.xml | 0
docs/{ => resources}/diagrams/fwu_flow.png | Bin
docs/{ => resources}/diagrams/fwu_states.png | Bin
docs/{ => resources}/diagrams/int_handling.dia | Bin
.../diagrams/non-sec-int-handling.png | Bin
.../diagrams}/plantuml/plantuml_to_svg.sh | 0
.../diagrams}/plantuml/sdei_explicit_dispatch.puml | 0
.../diagrams}/plantuml/sdei_explicit_dispatch.svg | 0
.../diagrams}/plantuml/sdei_general.puml | 0
.../diagrams}/plantuml/sdei_general.svg | 0
.../diagrams/psci-suspend-sequence.png | Bin
docs/{ => resources}/diagrams/reset_code_flow.dia | Bin
.../diagrams/reset_code_no_boot_type_check.png | Bin
.../diagrams/reset_code_no_checks.png | Bin
.../diagrams/reset_code_no_cpu_check.png | Bin
docs/{ => resources}/diagrams/romlib_design.dia | Bin
docs/{ => resources}/diagrams/romlib_design.png | Bin
docs/{ => resources}/diagrams/romlib_wrapper.dia | Bin
docs/{ => resources}/diagrams/romlib_wrapper.png | Bin
.../diagrams/rt-svc-descs-layout.png | Bin
docs/{ => resources}/diagrams/sec-int-handling.png | Bin
.../{ => resources}/diagrams/secure_sw_stack_sp.png | Bin
.../diagrams/secure_sw_stack_tos.png | Bin
docs/{ => resources}/diagrams/xlat_align.dia | Bin
docs/{ => resources}/diagrams/xlat_align.png | Bin
40 files changed, 18 insertions(+), 18 deletions(-)
rename docs/{ => resources}/diagrams/Makefile (100%)
rename docs/{ => resources}/diagrams/default_reset_code.png (100%)
rename docs/{ => resources/diagrams}/draw.io/ehf.svg (100%)
rename docs/{ => resources/diagrams}/draw.io/ehf.xml (100%)
rename docs/{ => resources/diagrams}/draw.io/ras.svg (100%)
rename docs/{ => resources/diagrams}/draw.io/ras.xml (100%)
rename docs/{ => resources}/diagrams/fwu_flow.png (100%)
rename docs/{ => resources}/diagrams/fwu_states.png (100%)
rename docs/{ => resources}/diagrams/int_handling.dia (100%)
rename docs/{ => resources}/diagrams/non-sec-int-handling.png (100%)
rename docs/{ => resources/diagrams}/plantuml/plantuml_to_svg.sh (100%)
mode change 100755 => 100644
rename docs/{ => resources/diagrams}/plantuml/sdei_explicit_dispatch.puml (100%)
rename docs/{ => resources/diagrams}/plantuml/sdei_explicit_dispatch.svg (100%)
rename docs/{ => resources/diagrams}/plantuml/sdei_general.puml (100%)
rename docs/{ => resources/diagrams}/plantuml/sdei_general.svg (100%)
rename docs/{ => resources}/diagrams/psci-suspend-sequence.png (100%)
rename docs/{ => resources}/diagrams/reset_code_flow.dia (100%)
rename docs/{ => resources}/diagrams/reset_code_no_boot_type_check.png (100%)
rename docs/{ => resources}/diagrams/reset_code_no_checks.png (100%)
rename docs/{ => resources}/diagrams/reset_code_no_cpu_check.png (100%)
rename docs/{ => resources}/diagrams/romlib_design.dia (100%)
mode change 100755 => 100644
rename docs/{ => resources}/diagrams/romlib_design.png (100%)
mode change 100755 => 100644
rename docs/{ => resources}/diagrams/romlib_wrapper.dia (100%)
mode change 100755 => 100644
rename docs/{ => resources}/diagrams/romlib_wrapper.png (100%)
mode change 100755 => 100644
rename docs/{ => resources}/diagrams/rt-svc-descs-layout.png (100%)
rename docs/{ => resources}/diagrams/sec-int-handling.png (100%)
rename docs/{ => resources}/diagrams/secure_sw_stack_sp.png (100%)
rename docs/{ => resources}/diagrams/secure_sw_stack_tos.png (100%)
rename docs/{ => resources}/diagrams/xlat_align.dia (100%)
rename docs/{ => resources}/diagrams/xlat_align.png (100%)
diff --git a/docs/components/exception-handling.rst b/docs/components/exception-handling.rst
index a89a05c97..30600f95c 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 608803d57..31f5917e0 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 9d56e63a5..137c0c301 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 ab39723f0..a70ed17ff 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 7b6cc913d..845a29556 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 88052c552..ac1172c8f 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 a78d35116..786dd3bcb 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 e9384e62b..710d26ded 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 d4057ea42..b19f7f73d 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 c38f62748..b5c9bb410 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
similarity index 100%
rename from docs/diagrams/Makefile
rename to docs/resources/diagrams/Makefile
diff --git a/docs/diagrams/default_reset_code.png b/docs/resources/diagrams/default_reset_code.png
similarity index 100%
rename from docs/diagrams/default_reset_code.png
rename to docs/resources/diagrams/default_reset_code.png
diff --git a/docs/draw.io/ehf.svg b/docs/resources/diagrams/draw.io/ehf.svg
similarity index 100%
rename from docs/draw.io/ehf.svg
rename to docs/resources/diagrams/draw.io/ehf.svg
diff --git a/docs/draw.io/ehf.xml b/docs/resources/diagrams/draw.io/ehf.xml
similarity index 100%
rename from docs/draw.io/ehf.xml
rename to docs/resources/diagrams/draw.io/ehf.xml
diff --git a/docs/draw.io/ras.svg b/docs/resources/diagrams/draw.io/ras.svg
similarity index 100%
rename from docs/draw.io/ras.svg
rename to docs/resources/diagrams/draw.io/ras.svg
diff --git a/docs/draw.io/ras.xml b/docs/resources/diagrams/draw.io/ras.xml
similarity index 100%
rename from docs/draw.io/ras.xml
rename to docs/resources/diagrams/draw.io/ras.xml
diff --git a/docs/diagrams/fwu_flow.png b/docs/resources/diagrams/fwu_flow.png
similarity index 100%
rename from docs/diagrams/fwu_flow.png
rename to docs/resources/diagrams/fwu_flow.png
diff --git a/docs/diagrams/fwu_states.png b/docs/resources/diagrams/fwu_states.png
similarity index 100%
rename from docs/diagrams/fwu_states.png
rename to docs/resources/diagrams/fwu_states.png
diff --git a/docs/diagrams/int_handling.dia b/docs/resources/diagrams/int_handling.dia
similarity index 100%
rename from docs/diagrams/int_handling.dia
rename to docs/resources/diagrams/int_handling.dia
diff --git a/docs/diagrams/non-sec-int-handling.png b/docs/resources/diagrams/non-sec-int-handling.png
similarity index 100%
rename from docs/diagrams/non-sec-int-handling.png
rename to docs/resources/diagrams/non-sec-int-handling.png
diff --git a/docs/plantuml/plantuml_to_svg.sh b/docs/resources/diagrams/plantuml/plantuml_to_svg.sh
old mode 100755
new mode 100644
similarity index 100%
rename from docs/plantuml/plantuml_to_svg.sh
rename to 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
similarity index 100%
rename from docs/plantuml/sdei_explicit_dispatch.puml
rename to 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
similarity index 100%
rename from docs/plantuml/sdei_explicit_dispatch.svg
rename to docs/resources/diagrams/plantuml/sdei_explicit_dispatch.svg
diff --git a/docs/plantuml/sdei_general.puml b/docs/resources/diagrams/plantuml/sdei_general.puml
similarity index 100%
rename from docs/plantuml/sdei_general.puml
rename to docs/resources/diagrams/plantuml/sdei_general.puml
diff --git a/docs/plantuml/sdei_general.svg b/docs/resources/diagrams/plantuml/sdei_general.svg
similarity index 100%
rename from docs/plantuml/sdei_general.svg
rename to docs/resources/diagrams/plantuml/sdei_general.svg
diff --git a/docs/diagrams/psci-suspend-sequence.png b/docs/resources/diagrams/psci-suspend-sequence.png
similarity index 100%
rename from docs/diagrams/psci-suspend-sequence.png
rename to docs/resources/diagrams/psci-suspend-sequence.png
diff --git a/docs/diagrams/reset_code_flow.dia b/docs/resources/diagrams/reset_code_flow.dia
similarity index 100%
rename from docs/diagrams/reset_code_flow.dia
rename to docs/resources/diagrams/reset_code_flow.dia
diff --git a/docs/diagrams/reset_code_no_boot_type_check.png b/docs/resources/diagrams/reset_code_no_boot_type_check.png
similarity index 100%
rename from docs/diagrams/reset_code_no_boot_type_check.png
rename to docs/resources/diagrams/reset_code_no_boot_type_check.png
diff --git a/docs/diagrams/reset_code_no_checks.png b/docs/resources/diagrams/reset_code_no_checks.png
similarity index 100%
rename from docs/diagrams/reset_code_no_checks.png
rename to docs/resources/diagrams/reset_code_no_checks.png
diff --git a/docs/diagrams/reset_code_no_cpu_check.png b/docs/resources/diagrams/reset_code_no_cpu_check.png
similarity index 100%
rename from docs/diagrams/reset_code_no_cpu_check.png
rename to docs/resources/diagrams/reset_code_no_cpu_check.png
diff --git a/docs/diagrams/romlib_design.dia b/docs/resources/diagrams/romlib_design.dia
old mode 100755
new mode 100644
similarity index 100%
rename from docs/diagrams/romlib_design.dia
rename to docs/resources/diagrams/romlib_design.dia
diff --git a/docs/diagrams/romlib_design.png b/docs/resources/diagrams/romlib_design.png
old mode 100755
new mode 100644
similarity index 100%
rename from docs/diagrams/romlib_design.png
rename to docs/resources/diagrams/romlib_design.png
diff --git a/docs/diagrams/romlib_wrapper.dia b/docs/resources/diagrams/romlib_wrapper.dia
old mode 100755
new mode 100644
similarity index 100%
rename from docs/diagrams/romlib_wrapper.dia
rename to docs/resources/diagrams/romlib_wrapper.dia
diff --git a/docs/diagrams/romlib_wrapper.png b/docs/resources/diagrams/romlib_wrapper.png
old mode 100755
new mode 100644
similarity index 100%
rename from docs/diagrams/romlib_wrapper.png
rename to docs/resources/diagrams/romlib_wrapper.png
diff --git a/docs/diagrams/rt-svc-descs-layout.png b/docs/resources/diagrams/rt-svc-descs-layout.png
similarity index 100%
rename from docs/diagrams/rt-svc-descs-layout.png
rename to docs/resources/diagrams/rt-svc-descs-layout.png
diff --git a/docs/diagrams/sec-int-handling.png b/docs/resources/diagrams/sec-int-handling.png
similarity index 100%
rename from docs/diagrams/sec-int-handling.png
rename to docs/resources/diagrams/sec-int-handling.png
diff --git a/docs/diagrams/secure_sw_stack_sp.png b/docs/resources/diagrams/secure_sw_stack_sp.png
similarity index 100%
rename from docs/diagrams/secure_sw_stack_sp.png
rename to docs/resources/diagrams/secure_sw_stack_sp.png
diff --git a/docs/diagrams/secure_sw_stack_tos.png b/docs/resources/diagrams/secure_sw_stack_tos.png
similarity index 100%
rename from docs/diagrams/secure_sw_stack_tos.png
rename to docs/resources/diagrams/secure_sw_stack_tos.png
diff --git a/docs/diagrams/xlat_align.dia b/docs/resources/diagrams/xlat_align.dia
similarity index 100%
rename from docs/diagrams/xlat_align.dia
rename to docs/resources/diagrams/xlat_align.dia
diff --git a/docs/diagrams/xlat_align.png b/docs/resources/diagrams/xlat_align.png
similarity index 100%
rename from docs/diagrams/xlat_align.png
rename to docs/resources/diagrams/xlat_align.png
--
GitLab