diff mbox series

[v2,1/2] doc: Add documentation for the Arm VExpress64 board configs

Message ID 20211220181204.739910-2-andre.przywara@arm.com
State Accepted, archived
Delegated to: Heinrich Schuchardt
Headers show
Series Arm Juno board documentation | expand

Commit Message

Andre Przywara Dec. 20, 2021, 6:12 p.m. UTC
From: Peter Hoyes <Peter.Hoyes@arm.com>

Create a new documentation section for Arm Ltd boards with a sub-page
for the FVP VExpress64 system.

Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
[Andre: remove Juno stub, RSTify]
Signed-off-by: Andre Przywara <andre.przywara@arm.com>
---
 doc/board/armltd/fvp64.rst | 30 ++++++++++++++++++++++++++++++
 doc/board/armltd/index.rst | 10 ++++++++++
 doc/board/index.rst        |  1 +
 3 files changed, 41 insertions(+)
 create mode 100644 doc/board/armltd/fvp64.rst
 create mode 100644 doc/board/armltd/index.rst

Comments

Sudeep Holla Dec. 21, 2021, 2:34 p.m. UTC | #1
On Mon, Dec 20, 2021 at 06:12:03PM +0000, Andre Przywara wrote:
> From: Peter Hoyes <Peter.Hoyes@arm.com>
> 
> Create a new documentation section for Arm Ltd boards with a sub-page
> for the FVP VExpress64 system.
>

Reviewed-by: Sudeep Holla <sudeep.holla@arm.com>
Linus Walleij Dec. 22, 2021, 2:42 a.m. UTC | #2
On Mon, Dec 20, 2021 at 7:12 PM Andre Przywara <andre.przywara@arm.com> wrote:

> From: Peter Hoyes <Peter.Hoyes@arm.com>
>
> Create a new documentation section for Arm Ltd boards with a sub-page
> for the FVP VExpress64 system.
>
> Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
> [Andre: remove Juno stub, RSTify]
> Signed-off-by: Andre Przywara <andre.przywara@arm.com>

Reviewed-by: Linus Walleij <linus.walleij@linaro.org>

Yours,
Linus Walleij
Simon Glass Dec. 28, 2021, 8:33 a.m. UTC | #3
On Mon, 20 Dec 2021 at 11:12, Andre Przywara <andre.przywara@arm.com> wrote:
>
> From: Peter Hoyes <Peter.Hoyes@arm.com>
>
> Create a new documentation section for Arm Ltd boards with a sub-page
> for the FVP VExpress64 system.
>
> Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
> [Andre: remove Juno stub, RSTify]
> Signed-off-by: Andre Przywara <andre.przywara@arm.com>
> ---
>  doc/board/armltd/fvp64.rst | 30 ++++++++++++++++++++++++++++++
>  doc/board/armltd/index.rst | 10 ++++++++++
>  doc/board/index.rst        |  1 +
>  3 files changed, 41 insertions(+)
>  create mode 100644 doc/board/armltd/fvp64.rst
>  create mode 100644 doc/board/armltd/index.rst

Reviewed-by: Simon Glass <sjg@chromium.org>
Missing change log
diff mbox series

Patch

diff --git a/doc/board/armltd/fvp64.rst b/doc/board/armltd/fvp64.rst
new file mode 100644
index 0000000000..4dc341bf2a
--- /dev/null
+++ b/doc/board/armltd/fvp64.rst
@@ -0,0 +1,30 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+Fixed Virtual Platforms
+=======================
+
+The Fixed Virtual Platforms (FVP) are complete software simulations of an Arm
+system, including processor, memory and peripherals. They are set out in a
+"programmer's view", which gives a comprehensive model on which to build and
+test software.
+
+The supported FVPs are available free of charge and can be downloaded from the
+`Arm developer site`_ (user registration might be required).
+
+Supported features:
+
+ * GICv3
+ * Generic timer
+ * PL011 UART
+
+The default configuration assumes that U-Boot is bootstrapped using a suitable
+bootloader, such as `Trusted Firmware-A`_. The U-Boot binary can be passed
+into the TF-A build::
+
+    make PLAT=fvp all fip BL33=/path/to/u-boot.bin
+
+The FVPs can be debugged using `Arm Development Studio`_.
+
+.. _`Arm developer site`: https://developer.arm.com/tools-and-software/simulation-models/fixed-virtual-platforms
+.. _`Trusted Firmware-A`: https://www.trustedfirmware.org/projects/tf-a/
+.. _`Arm Development Studio`: https://developer.arm.com/tools-and-software/embedded/arm-development-studio
diff --git a/doc/board/armltd/index.rst b/doc/board/armltd/index.rst
new file mode 100644
index 0000000000..caa6fd2bb0
--- /dev/null
+++ b/doc/board/armltd/index.rst
@@ -0,0 +1,10 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+.. Copyright (C) 2021 Arm Ltd.
+
+ARM Ltd. boards and emulated systems
+====================================
+
+.. toctree::
+   :maxdepth: 2
+
+   fvp64
diff --git a/doc/board/index.rst b/doc/board/index.rst
index 13f4db848e..d0a7838550 100644
--- a/doc/board/index.rst
+++ b/doc/board/index.rst
@@ -11,6 +11,7 @@  Board-specific doc
    AndesTech/index
    amlogic/index
    apple/index
+   armltd/index
    atmel/index
    congatec/index
    coreboot/index