diff --git a/docs/change-log.rst b/docs/change-log.rst index 22effb135..71f24fd62 100644 --- a/docs/change-log.rst +++ b/docs/change-log.rst @@ -2425,7 +2425,7 @@ releases of TF-A. .. _SDEI Specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf .. _PSCI Integration Guide: ./getting_started/psci-lib-integration-guide.rst .. _Developer Certificate of Origin: ../dco.txt -.. _Contribution Guide: ./contributing.rst +.. _Contribution Guide: ./process/contributing.rst .. _Authentication framework: ./design/auth-framework.rst .. _Firmware Update: ./design/firmware-update.rst .. _Firmware Design: ./design/firmware-design.rst diff --git a/docs/components/arm-sip-service.rst b/docs/components/arm-sip-service.rst index 9cbf19946..e450d3756 100644 --- a/docs/components/arm-sip-service.rst +++ b/docs/components/arm-sip-service.rst @@ -92,5 +92,5 @@ respectively. *Copyright (c) 2017-2018, Arm Limited and Contributors. All rights reserved.* .. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html -.. _Performance Measurement Framework: ./firmware-design.rst#user-content-performance-measurement-framework -.. _Firmware Design document: ./firmware-design.rst +.. _Performance Measurement Framework: ../design/firmware-design.rst#user-content-performance-measurement-framework +.. _Firmware Design document: ../design/firmware-design.rst diff --git a/docs/components/exception-handling.rst b/docs/components/exception-handling.rst index 8f74eb657..0d0173318 100644 --- a/docs/components/exception-handling.rst +++ b/docs/components/exception-handling.rst @@ -622,5 +622,5 @@ The |EHF| has the following limitations: *Copyright (c) 2018, Arm Limited and Contributors. All rights reserved.* -.. _Interrupt Framework Design: interrupt-framework-design.rst +.. _Interrupt Framework Design: ../design/interrupt-framework-design.rst .. _SDEI specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf diff --git a/docs/components/firmware-update.rst b/docs/components/firmware-update.rst index 31f5917e0..d6bb6ce8a 100644 --- a/docs/components/firmware-update.rst +++ b/docs/components/firmware-update.rst @@ -394,10 +394,10 @@ This is only allowed if the image is not being executed. *Copyright (c) 2015-2018, Arm Limited and Contributors. All rights reserved.* -.. _Trusted Board Boot: ./trusted-board-boot.rst +.. _Trusted Board Boot: ../design/trusted-board-boot.rst .. _Porting Guide: ../getting_started/porting-guide.rst .. _here: https://github.com/ARM-software/arm-trusted-firmware/wiki/ARM-Trusted-Firmware-Image-Terminology -.. _Authentication Framework Design: ./auth-framework.rst +.. _Authentication Framework Design: ../design/auth-framework.rst .. _Universally Unique Identifier: https://tools.ietf.org/rfc/rfc4122.txt .. |Flow Diagram| image:: ../resources/diagrams/fwu_flow.png diff --git a/docs/design/firmware-design.rst b/docs/design/firmware-design.rst index e4e2bc1d8..00e199a20 100644 --- a/docs/design/firmware-design.rst +++ b/docs/design/firmware-design.rst @@ -19,7 +19,7 @@ in either security state. The details of the interrupt management framework and its design can be found in TF-A Interrupt Management Design guide [4]_. TF-A also implements a library for setting up and managing the translation -tables. The details of this library can be found in `Xlat_tables design`_. +tables. The details of this library can be found in `Translation tables design`_. TF-A can be built to support either AArch64 or AArch32 execution state. @@ -1333,7 +1333,7 @@ different CPUs during power down and reset handling. The platform can specify any CPU optimization it wants to enable for each CPU. It can also specify the CPU errata workarounds to be applied for each CPU type during reset handling by defining CPU errata compile time macros. Details on these macros -can be found in the `cpu-specific-build-macros.rst`_ file. +can be found in `CPU specific build macros`_. The CPU specific operations framework depends on the ``cpu_ops`` structure which needs to be exported for each type of CPU in the platform. It is defined in @@ -2670,7 +2670,7 @@ References .. _Reset Design: ./reset-design.rst .. _Porting Guide: ../getting_started/porting-guide.rst -.. _Firmware Update: ./firmware-update.rst +.. _Firmware Update: ../components/firmware-update.rst .. _PSCI PDD: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf .. _SMC calling convention PDD: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf .. _PSCI Library integration guide: ../getting_started/psci-lib-integration-guide.rst @@ -2678,15 +2678,15 @@ References .. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf .. _Power State Coordination Interface PDD: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf .. _here: ../getting_started/psci-lib-integration-guide.rst -.. _cpu-specific-build-macros.rst: ./cpu-specific-build-macros.rst +.. _CPU specific build macros: ./cpu-specific-build-macros.rst .. _CPUBM: ./cpu-specific-build-macros.rst .. _Arm ARM: http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0487a.e/index.html .. _User Guide: ../getting_started/user-guide.rst .. _SMC Calling Convention PDD: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf .. _TF-A Interrupt Management Design guide: ./interrupt-framework-design.rst -.. _Xlat_tables design: xlat-tables-lib-v2-design.rst -.. _Exception Handling Framework: exception-handling.rst -.. _ROMLIB Design: romlib-design.rst +.. _Translation tables design: ../components/xlat-tables-lib-v2-design.rst +.. _Exception Handling Framework: ../components/exception-handling.rst +.. _ROMLIB Design: ../components/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:: ../resources/diagrams/rt-svc-descs-layout.png diff --git a/docs/design/trusted-board-boot.rst b/docs/design/trusted-board-boot.rst index 6f648f513..82be272bf 100644 --- a/docs/design/trusted-board-boot.rst +++ b/docs/design/trusted-board-boot.rst @@ -227,7 +227,7 @@ for building and using the tool can be found in the `User Guide`_. *Copyright (c) 2015-2019, Arm Limited and Contributors. All rights reserved.* -.. _Firmware Update: firmware-update.rst +.. _Firmware Update: ../components/firmware-update.rst .. _X.509 v3: https://tools.ietf.org/rfc/rfc5280.txt .. _User Guide: ../getting_started/user-guide.rst .. _Auth Framework: auth-framework.rst diff --git a/docs/getting_started/porting-guide.rst b/docs/getting_started/porting-guide.rst index 94ec93232..72865a517 100644 --- a/docs/getting_started/porting-guide.rst +++ b/docs/getting_started/porting-guide.rst @@ -2821,14 +2821,14 @@ amount of open resources per driver. .. _plat/common/aarch64/platform_mp_stack.S: ../plat/common/aarch64/platform_mp_stack.S .. _plat/common/aarch64/platform_up_stack.S: ../plat/common/aarch64/platform_up_stack.S .. _For example, define the build flag in platform.mk: PLAT_PL061_MAX_GPIOS%20:=%20160 -.. _Power Domain Topology Design: psci-pd-tree.rst +.. _Power Domain Topology Design: ../design/psci-pd-tree.rst .. _include/common/bl_common.h: ../include/common/bl_common.h .. _include/lib/aarch32/arch.h: ../include/lib/aarch32/arch.h -.. _Firmware Design: firmware-design.rst +.. _Firmware Design: ../design/firmware-design.rst .. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022c/DEN0022C_Power_State_Coordination_Interface.pdf .. _plat/arm/board/fvp/fvp_pm.c: ../plat/arm/board/fvp/fvp_pm.c -.. _Platform compatibility policy: ./platform-compatibility-policy.rst -.. _IMF Design Guide: interrupt-framework-design.rst +.. _Platform compatibility policy: ../process/platform-compatibility-policy.rst +.. _IMF Design Guide: ../design/interrupt-framework-design.rst .. _Arm Generic Interrupt Controller version 2.0 (GICv2): http://infocenter.arm.com/help/topic/com.arm.doc.ihi0048b/index.html .. _3.0 (GICv3): http://infocenter.arm.com/help/topic/com.arm.doc.ihi0069b/index.html .. _FreeBSD: https://www.freebsd.org diff --git a/docs/getting_started/psci-lib-integration-guide.rst b/docs/getting_started/psci-lib-integration-guide.rst index f5ea0d78b..25936d900 100644 --- a/docs/getting_started/psci-lib-integration-guide.rst +++ b/docs/getting_started/psci-lib-integration-guide.rst @@ -544,5 +544,5 @@ workarounds. .. _SMCCC: https://silver.arm.com/download/ARM_and_AMBA_Architecture/AR570-DA-80002-r0p0-00rel0/ARM_DEN0028A_SMC_Calling_Convention.pdf .. _PSCI specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0022c/DEN0022C_Power_State_Coordination_Interface.pdf .. _PSCI Specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0022c/DEN0022C_Power_State_Coordination_Interface.pdf -.. _Porting Guide: ../getting_started/porting-guide.rst +.. _Porting Guide: ./porting-guide.rst .. _Firmware Design: ../design/firmware-design.rst diff --git a/docs/getting_started/rt-svc-writers-guide.rst b/docs/getting_started/rt-svc-writers-guide.rst index 03212af1a..6c17a1fb4 100644 --- a/docs/getting_started/rt-svc-writers-guide.rst +++ b/docs/getting_started/rt-svc-writers-guide.rst @@ -300,7 +300,7 @@ provide this information.... .. _SMCCC: http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html .. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022c/DEN0022C_Power_State_Coordination_Interface.pdf -.. _Firmware Design: ../designb_documents/firmware-design.rst +.. _Firmware Design: ../design/firmware-design.rst .. _services: ../../services .. _lib/psci: ../../lib/psci .. _runtime_svc.h: ../../include/common/runtime_svc.h diff --git a/docs/getting_started/user-guide.rst b/docs/getting_started/user-guide.rst index db3654888..1a4df03d4 100644 --- a/docs/getting_started/user-guide.rst +++ b/docs/getting_started/user-guide.rst @@ -2160,17 +2160,17 @@ wakeup interrupt from RTC. .. _Linux master tree: https://github.com/torvalds/linux/tree/master/ .. _Dia: https://wiki.gnome.org/Apps/Dia/Download .. _here: psci-lib-integration-guide.rst -.. _Trusted Board Boot: trusted-board-boot.rst -.. _TB_FW_CONFIG for FVP: ../plat/arm/board/fvp/fdts/fvp_tb_fw_config.dts -.. _Secure-EL1 Payloads and Dispatchers: firmware-design.rst#user-content-secure-el1-payloads-and-dispatchers -.. _Firmware Update: firmware-update.rst -.. _Firmware Design: firmware-design.rst +.. _Trusted Board Boot: ../design/trusted-board-boot.rst +.. _TB_FW_CONFIG for FVP: ../../plat/arm/board/fvp/fdts/fvp_tb_fw_config.dts +.. _Secure-EL1 Payloads and Dispatchers: ../design/firmware-design.rst#user-content-secure-el1-payloads-and-dispatchers +.. _Firmware Update: ../components/firmware-update.rst +.. _Firmware Design: ../design/firmware-design.rst .. _mbed TLS Repository: https://github.com/ARMmbed/mbedtls.git .. _mbed TLS Security Center: https://tls.mbed.org/security .. _Arm's website: `FVP models`_ .. _FVP models: https://developer.arm.com/products/system-design/fixed-virtual-platforms .. _Juno Getting Started Guide: http://infocenter.arm.com/help/topic/com.arm.doc.dui0928e/DUI0928E_juno_arm_development_platform_gsg.pdf .. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf -.. _Secure Partition Manager Design guide: secure-partition-manager-design.rst -.. _`Trusted Firmware-A Coding Guidelines`: coding-guidelines.rst -.. _`Library at ROM`: romlib-design.rst +.. _Secure Partition Manager Design guide: ../components/secure-partition-manager-design.rst +.. _`Trusted Firmware-A Coding Guidelines`: ../process/coding-guidelines.rst +.. _Library at ROM: ../components/romlib-design.rst diff --git a/docs/index.rst b/docs/index.rst index 6f6cfdff0..c1474e5cb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -300,21 +300,11 @@ Arm licensees may contact Arm directly via their partner managers. .. _Trusty Secure OS: https://source.android.com/security/trusty .. _trustedfirmware.org: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git .. _issue tracker: https://issues.trustedfirmware.org -.. _Security Center: ./docs/security-center.rst +.. _Security Center: ./process/security.rst .. _license: ./license.rst -.. _Contributing Guidelines: ./contributing.rst +.. _Contributing Guidelines: ./process/contributing.rst .. _Acknowledgments: ./acknowledgements.rst -.. _Firmware Design: ./docs/firmware-design.rst -.. _Change Log: ./docs/change-log.rst -.. _User Guide: ./docs/user-guide.rst -.. _Porting Guide: ./docs/porting-guide.rst -.. _FreeBSD: http://www.freebsd.org -.. _SCC: http://www.simple-cc.org/ -.. _Security Advisory TFV-1: ./docs/security_advisories/security-advisory-tfv-1.rst -.. _Security Advisory TFV-2: ./docs/security_advisories/security-advisory-tfv-2.rst -.. _Security Advisory TFV-3: ./docs/security_advisories/security-advisory-tfv-3.rst -.. _Security Advisory TFV-4: ./docs/security_advisories/security-advisory-tfv-4.rst -.. _Security Advisory TFV-5: ./docs/security_advisories/security-advisory-tfv-5.rst -.. _Security Advisory TFV-6: ./docs/security_advisories/security-advisory-tfv-6.rst -.. _Security Advisory TFV-7: ./docs/security_advisories/security-advisory-tfv-7.rst -.. _Security Advisory TFV-8: ./docs/security_advisories/security-advisory-tfv-8.rst +.. _Firmware Design: ./design/firmware-design.rst +.. _Change Log: ./change-log.rst +.. _User Guide: ./getting_started/user-guide.rst +.. _Porting Guide: ./getting_started/porting-guide.rst diff --git a/docs/process/contributing.rst b/docs/process/contributing.rst index 8f8143f87..66b282c91 100644 --- a/docs/process/contributing.rst +++ b/docs/process/contributing.rst @@ -13,9 +13,9 @@ Getting Started raise a separate `issue`_ for this and ensure that the changes that include Third Party IP are made on a separate topic branch. -- Clone `arm-trusted-firmware-a`_ on your own machine as suggested on the +- Clone `Trusted Firmware-A`_ on your own machine as suggested on the `User Guide`_. -- Create a local topic branch based on the `arm-trusted-firmware-a`_ ``master`` +- Create a local topic branch based on the `Trusted Firmware-A`_ ``master`` branch. Making Changes @@ -130,17 +130,17 @@ Binary Components .. _developer.trustedfirmware.org: https://developer.trustedfirmware.org .. _issue: https://developer.trustedfirmware.org/project/board/1/ -.. _arm-trusted-firmware-a: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git +.. _Trusted Firmware-A: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git .. _Git guidelines: http://git-scm.com/book/ch5-2.html -.. _Coding Guidelines: ./docs/coding-guidelines.rst -.. _User Guide: ./docs/user-guide.rst -.. _Porting Guide: ./docs/porting-guide.rst -.. _Firmware Design: ./docs/firmware-design.rst -.. _license.rst: ./license.rst -.. _Acknowledgements: ./acknowledgements.rst -.. _Maintainers: ./maintainers.rst -.. _Running the software on FVP: ./docs/user-guide.rst#user-content-running-the-software-on-fvp -.. _Developer Certificate of Origin (DCO): ./dco.txt +.. _Coding Guidelines: ./coding-guidelines.rst +.. _User Guide: ../getting_started/user-guide.rst +.. _Porting Guide: ../getting_started/porting-guide.rst +.. _Firmware Design: ../design/firmware-design.rst +.. _license.rst: ../license.rst +.. _Acknowledgements: ../acknowledgements.rst +.. _Maintainers: ../maintainers.rst +.. _Running the software on FVP: ../getting_started/user-guide.rst#user-content-running-the-software-on-fvp +.. _Developer Certificate of Origin (DCO): ../../dco.txt .. _Gerrit Uploading Changes documentation: https://review.trustedfirmware.org/Documentation/user-upload.html .. _Gerrit Signed-off-by Lines guidelines: https://review.trustedfirmware.org/Documentation/user-signedoffby.html .. _Gerrit Change-Ids documentation: https://review.trustedfirmware.org/Documentation/user-changeid.html