arm-trusted-firmware/docs/plat
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
..
arm docs(fvp): restructure FVP platform documentation 2024-04-22 08:54:30 +01:00
marvell Merge "docs(marvell): fix typo 8K => A8K" into integration 2022-11-16 18:13:48 +01:00
nxp docs(layerscape): add ls1088a soc and board support 2022-03-27 23:24:24 +08:00
st docs(st): set OP-TEE as default BL32 2024-03-19 11:02:24 +01:00
allwinner.rst feat(allwinner): add support for Allwinner T507 SoC 2023-04-26 17:45:29 +01:00
ast2700.rst refactor(ast2700): adopt RESET_TO_BL31 boot flow 2023-09-28 10:23:06 +08:00
brcm-stingray.rst Fix Broadcom Stingray platform documentation 2020-04-15 11:20:40 +02:00
hikey.rst docs: remove uefi-tools in hikey and hikey960 2020-03-14 10:24:41 +08:00
hikey960.rst docs: remove uefi-tools in hikey and hikey960 2020-03-14 10:24:41 +08:00
imx8.rst doc: Reformat platform port documents 2019-05-22 11:22:44 +01:00
imx8m.rst docs(imx8m): update for high assurance boot 2022-10-19 15:55:15 +02:00
imx8ulp.rst docs(imx8ulp): add imx8ulp platform 2024-02-27 14:29:54 +08:00
imx9.rst docs(imx9): add imx93 platform 2023-06-30 10:24:05 +08:00
index.rst docs(plat): remove TC1 entry from the deprecation table 2024-04-19 11:18:44 +01:00
intel-agilex.rst doc: Fix platform port inclusion 2019-09-25 15:19:29 +00:00
intel-stratix10.rst doc: Fix platform port inclusion 2019-09-25 15:19:29 +00:00
meson-axg.rst doc: Fix some broken links 2020-07-01 13:57:20 +02:00
meson-g12a.rst doc: Fix some broken links 2020-07-01 13:57:20 +02:00
meson-gxbb.rst doc: Fix broken external link for Odroid C2 2020-03-31 20:38:01 +02:00
meson-gxl.rst doc: Fix some broken links 2020-07-01 13:57:20 +02:00
mt8183.rst doc: Reformat platform port documents 2019-05-22 11:22:44 +01:00
mt8186.rst feat(mt8186): initialize platform for MediaTek MT8186 2021-12-01 16:36:28 +01:00
mt8188.rst feat(mt8188): initialize platform for MediaTek MT8188 2022-09-05 13:52:20 +08:00
mt8192.rst Initialize platform for MediaTek mt8192 2020-07-31 10:46:22 +08:00
mt8195.rst Initialize platform for MediaTek MT8195 2021-04-23 09:59:59 +08:00
npcm845x.rst feat(nuvoton): added support for npcm845x chip 2023-07-26 08:14:45 +03:00
nvidia-tegra.rst refactor(tegra132): deprecate platform 2021-08-16 11:58:24 -07:00
poplar.rst doc: Fix platform port inclusion 2019-09-25 15:19:29 +00:00
qemu-sbsa.rst qemu/qemu_sbsa: enable SPM support 2020-08-18 22:45:35 +00:00
qemu.rst docs(qemu): delineate flash based boot method 2023-02-07 09:59:41 +00:00
qti-msm8916.rst docs(msm8916): document new platforms 2023-07-19 12:56:08 +02:00
qti.rst feat(plat/qti/sc7280): support for qti sc7280 plat 2021-09-22 10:05:45 +02:00
rcar-gen3.rst doc: Reformat platform port documents 2019-05-22 11:22:44 +01:00
rockchip.rst fix(rockchip): fix documentation in how build bl31 in AARCH64 2024-01-15 11:25:58 +01:00
rpi3.rst chore: remove MULTI_CONSOLE_API references 2023-09-12 15:28:36 +02:00
rpi4.rst Fix documentation typos and misspellings 2021-01-21 12:51:31 +00:00
rpi5.rst feat(rpi): add Raspberry Pi 5 support 2024-03-08 21:05:08 +02:00
rz-g2.rst doc: renesas: Document platforms based on RZ/G2 SoC's 2021-01-13 19:15:57 +00:00
socionext-uniphier.rst doc: Split the User Guide into multiple files 2019-11-27 10:45:54 +00:00
stm32mp1.rst refactor(docs): add a sub-menu for ST platforms 2023-09-08 10:56:49 +02:00
synquacer.rst doc: Reformat platform port documents 2019-05-22 11:22:44 +01:00
ti-k3.rst doc: Reformat platform port documents 2019-05-22 11:22:44 +01:00
warp7.rst doc: Reformat platform port documents 2019-05-22 11:22:44 +01:00
xilinx-versal-net.rst docs(versal-net): update SMC convention 2024-02-26 14:29:08 +05:30
xilinx-versal.rst docs(versal): update SMC convention 2024-02-26 14:29:08 +05:30
xilinx-zynqmp.rst docs(zynqmp): update SMC convention 2024-02-26 14:28:58 +05:30