arm-trusted-firmware/docs
Sandrine Bailleux c540769349 docs(fvp): restructure FVP platform documentation
The Arm FVP documentation has grown organically over the years. As a
result, it has become a big document, which can be difficult to digest.

Also, the organization of some of the sections does not make sense. In
particular, all "Running on the ... FVP" sections live under a section
named "Booting a preloaded kernel image (Base FVP)". To illustrate this,
here is the current table of contents:

  Arm Fixed Virtual Platforms (FVP)
    Fixed Virtual Platform (FVP) Support
    Arm FVP Platform Specific Build Options
    Booting Firmware Update images
    Booting an EL3 payload
    Booting a preloaded kernel image (Base FVP)
      Obtaining the Flattened Device Treesp
      Running on the Foundation FVP with reset to BL1 entrypoint
      Running on the AEMv8 Base FVP with reset to BL1 entrypoint
      Running on the AEMv8 Base FVP (AArch32) with reset to BL1 entrypoint
      Running on the Cortex-A57-A53 Base FVP with reset to BL1 entrypoint
      Running on the Cortex-A32 Base FVP (AArch32) with reset to BL1 entrypoint
      Running on the AEMv8 Base FVP with reset to BL31 entrypoint
      Running on the AEMv8 Base FVP (AArch32) with reset to SP_MIN entrypoint
      Running on the Cortex-A57-A53 Base FVP with reset to BL31 entrypoint
      Running on the Cortex-A32 Base FVP (AArch32) with reset to SP_MIN entrypoint

This patch breaks down this document in sub-documents, which are now
included from the index file. The table of contents (ToC) reflects the
new documents hierarchy. The depth of the ToC has been reduced to
simplify the index page. Here is what it looks like now:

  Arm Fixed Virtual Platforms (FVP)
    Fixed Virtual Platform (FVP) Support
    Arm FVP Platform Specific Build Options
    Running on the Foundation FVP
    Running on the AEMv8 Base FVP
    Running on the Cortex-A57-A53 Base FVP
    Running on the Cortex-A32 Base FVP (AArch32)
    Booting Firmware Update images
    Booting an EL3 payload
    Booting a preloaded kernel image (Base FVP)

Apart from moving information around in separate files, this patch also
makes the following minor changes to the contents:

 - Add a brief introduction about FVPs in the index page.
 - Change some of the titles names for conciseness.

Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Signed-off-by: Manish V Badarkhe <Manish.Badarkhe@arm.com>
Change-Id: Icb650e0ec2c7a86ccd6e7eea4e16a84c41442c96
2024-04-22 08:54:30 +01:00
..
_static/css docs(threat model): add TF-A threat model 2021-04-30 17:59:22 +02:00
about docs: update release and code freeze dates 2024-04-04 15:29:53 +00:00
components fix(docs): typo in the romlib design 2024-04-18 10:14:21 +01:00
design refactor(mte): remove mte, mte_perm 2024-03-26 14:30:58 -05:00
design_documents refactor(fvp): remove RSS usage 2023-11-14 09:52:11 +02:00
getting_started docs: decrease the minimum supported OpenSSL 2024-04-16 13:46:57 +00:00
perf docs(juno): update PSCI instrumentation data 2023-11-14 14:38:16 +00:00
plat docs(fvp): restructure FVP platform documentation 2024-04-22 08:54:30 +01:00
process Merge "docs(contributing): various improvements" into integration 2024-02-02 13:54:12 +01:00
resources docs(auth): add more information about CoTs 2024-02-09 13:50:30 +01:00
security_advisories chore: rename Poseidon to Neoverse V3 2024-03-26 11:27:31 -05:00
threat_model docs(threat_model): cover the 'timing' side channel threat 2024-03-19 11:26:26 +00:00
tools feat(memmap): add topological memory view 2023-05-12 14:38:22 +01:00
change-log.md docs(changelog): changelog for v2.10 release 2023-11-22 11:52:02 +00:00
conf.py docs(changelog): changelog for v2.10 release 2023-11-22 11:52:02 +00:00
global_substitutions.txt docs(errata_abi): document the errata abi changes 2023-05-05 13:24:59 -05:00
glossary.rst feat(dice): add typedefs from the Open DICE repo 2024-03-06 15:44:55 +01:00
index.rst feat(fwu): update the URL links for the FWU specification 2024-03-01 14:19:56 +05:30
license.rst feat(dice): add typedefs from the Open DICE repo 2024-03-06 15:44:55 +01:00
Makefile feat(docs): allow verbose build 2023-03-21 11:47:16 +01:00
porting-guide.rst chore(auth)!: remove CryptoCell-712/713 support 2023-11-08 10:42:33 +02:00