diff mbox series

[3/5] docs/system: Document Arm Versatile Express boards

Message ID 20200507151819.28444-4-peter.maydell@linaro.org
State Superseded
Headers show
Series docs/system: Document some arm board models | expand

Commit Message

Peter Maydell May 7, 2020, 3:18 p.m. UTC
Provide a minimal documentation of the Versatile Express boards
(vexpress-a9, vexpress-a15).

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

---
 docs/system/arm/vexpress.rst | 60 ++++++++++++++++++++++++++++++++++++
 docs/system/target-arm.rst   |  1 +
 MAINTAINERS                  |  1 +
 3 files changed, 62 insertions(+)
 create mode 100644 docs/system/arm/vexpress.rst

-- 
2.20.1

Comments

Edgar E. Iglesias May 14, 2020, 1:55 p.m. UTC | #1
On Thu, May 07, 2020 at 04:18:17PM +0100, Peter Maydell wrote:
> Provide a minimal documentation of the Versatile Express boards

> (vexpress-a9, vexpress-a15).


Reviewed-by: Edgar E. Iglesias <edgar.iglesias@xilinx.com>



> 

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

> ---

>  docs/system/arm/vexpress.rst | 60 ++++++++++++++++++++++++++++++++++++

>  docs/system/target-arm.rst   |  1 +

>  MAINTAINERS                  |  1 +

>  3 files changed, 62 insertions(+)

>  create mode 100644 docs/system/arm/vexpress.rst

> 

> diff --git a/docs/system/arm/vexpress.rst b/docs/system/arm/vexpress.rst

> new file mode 100644

> index 00000000000..7f1bcbef078

> --- /dev/null

> +++ b/docs/system/arm/vexpress.rst

> @@ -0,0 +1,60 @@

> +Arm Versatile Express boards (``vexpress-a9``, ``vexpress-a15``)

> +================================================================

> +

> +QEMU models two variants of the Arm Versatile Express development

> +board family:

> +

> +- ``vexpress-a9`` models the combination of the Versatile Express

> +  motherboard and the CoreTile Express A9x4 daughterboard

> +- ``vexpress-a15`` models the combination of the Versatile Express

> +  motherboard and the CoreTile Express A15x2 daughterboard

> +

> +Note that as this hardware does not have PCI, IDE or SCSI,

> +the only available storage option is emulated SD card.

> +

> +Implemented devices:

> +

> +- PL041 audio

> +- PL181 SD controller

> +- PL050 keyboard and mouse

> +- PL011 UARTs

> +- SP804 timers

> +- I2C controller

> +- PL031 RTC

> +- PL111 LCD display controller

> +- Flash memory

> +- LAN9118 ethernet

> +

> +Unimplemented devices:

> +

> +- SP810 system control block

> +- PCI-express

> +- USB controller (Philips ISP1761)

> +- Local DAP ROM

> +- CoreSight interfaces

> +- PL301 AXI interconnect

> +- SCC

> +- System counter

> +- HDLCD controller (``vexpress-a15``)

> +- SP805 watchdog

> +- PL341 dynamic memory controller

> +- DMA330 DMA controller

> +- PL354 static memory controller

> +- BP147 TrustZone Protection Controller

> +- TrustZone Address Space Controller

> +

> +Other differences between the hardware and the QEMU model:

> +

> +- QEMU will default to creating one CPU unless you pass a different

> +  ``-smp`` argument

> +- QEMU allows the amount of RAM provided to be specified with the

> +  ``-m`` argument

> +- QEMU defaults to providing a CPU which does not provide either

> +  TrustZone or the Virtualization Extensions: if you want these you

> +  must enable them with ``-machine secure=on`` and ``-machine

> +  virtualization=on``

> +- QEMU provides 4 virtio-mmio virtio transports; these start at

> +  address ``0x10013000`` for ``vexpress-a9`` and at ``0x1c130000`` for

> +  ``vexpress-a15``, and have IRQs from 40 upwards. If a dtb is

> +  provided on the command line then QEMU will edit it to include

> +  suitable entries describing these transports for the guest.

> diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst

> index d1196cbe01c..4779293d731 100644

> --- a/docs/system/target-arm.rst

> +++ b/docs/system/target-arm.rst

> @@ -73,6 +73,7 @@ undocumented; you can get a complete list by running

>     arm/integratorcp

>     arm/realview

>     arm/versatile

> +   arm/vexpress

>     arm/musicpal

>     arm/nseries

>     arm/orangepi

> diff --git a/MAINTAINERS b/MAINTAINERS

> index 1f84e3ae2c6..74cff1c3818 100644

> --- a/MAINTAINERS

> +++ b/MAINTAINERS

> @@ -826,6 +826,7 @@ M: Peter Maydell <peter.maydell@linaro.org>

>  L: qemu-arm@nongnu.org

>  S: Maintained

>  F: hw/arm/vexpress.c

> +F: docs/system/arm/vexpress.rst

>  

>  Versatile PB

>  M: Peter Maydell <peter.maydell@linaro.org>

> -- 

> 2.20.1

> 

>
Alex Bennée May 15, 2020, 9:54 a.m. UTC | #2
Peter Maydell <peter.maydell@linaro.org> writes:

> Provide a minimal documentation of the Versatile Express boards

> (vexpress-a9, vexpress-a15).

>

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

> ---

>  docs/system/arm/vexpress.rst | 60 ++++++++++++++++++++++++++++++++++++

>  docs/system/target-arm.rst   |  1 +

>  MAINTAINERS                  |  1 +

>  3 files changed, 62 insertions(+)

>  create mode 100644 docs/system/arm/vexpress.rst

>

> diff --git a/docs/system/arm/vexpress.rst b/docs/system/arm/vexpress.rst

> new file mode 100644

> index 00000000000..7f1bcbef078

> --- /dev/null

> +++ b/docs/system/arm/vexpress.rst

> @@ -0,0 +1,60 @@

> +Arm Versatile Express boards (``vexpress-a9``, ``vexpress-a15``)

> +================================================================

> +

> +QEMU models two variants of the Arm Versatile Express development

> +board family:

> +

> +- ``vexpress-a9`` models the combination of the Versatile Express

> +  motherboard and the CoreTile Express A9x4 daughterboard

> +- ``vexpress-a15`` models the combination of the Versatile Express

> +  motherboard and the CoreTile Express A15x2 daughterboard

> +

> +Note that as this hardware does not have PCI, IDE or SCSI,

> +the only available storage option is emulated SD card.

> +

> +Implemented devices:

> +

> +- PL041 audio

> +- PL181 SD controller

> +- PL050 keyboard and mouse

> +- PL011 UARTs

> +- SP804 timers

> +- I2C controller

> +- PL031 RTC

> +- PL111 LCD display controller

> +- Flash memory

> +- LAN9118 ethernet

> +

> +Unimplemented devices:

> +

> +- SP810 system control block

> +- PCI-express

> +- USB controller (Philips ISP1761)

> +- Local DAP ROM

> +- CoreSight interfaces

> +- PL301 AXI interconnect

> +- SCC

> +- System counter

> +- HDLCD controller (``vexpress-a15``)

> +- SP805 watchdog

> +- PL341 dynamic memory controller

> +- DMA330 DMA controller

> +- PL354 static memory controller

> +- BP147 TrustZone Protection Controller

> +- TrustZone Address Space Controller

> +

> +Other differences between the hardware and the QEMU model:

> +

> +- QEMU will default to creating one CPU unless you pass a different

> +  ``-smp`` argument

> +- QEMU allows the amount of RAM provided to be specified with the

> +  ``-m`` argument

> +- QEMU defaults to providing a CPU which does not provide either

> +  TrustZone or the Virtualization Extensions: if you want these you

> +  must enable them with ``-machine secure=on`` and ``-machine

> +  virtualization=on``

> +- QEMU provides 4 virtio-mmio virtio transports; these start at

> +  address ``0x10013000`` for ``vexpress-a9`` and at ``0x1c130000`` for

> +  ``vexpress-a15``, and have IRQs from 40 upwards. If a dtb is

> +  provided on the command line then QEMU will edit it to include

> +  suitable entries describing these transports for the guest.


TIL ;-)

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>


-- 
Alex Bennée
diff mbox series

Patch

diff --git a/docs/system/arm/vexpress.rst b/docs/system/arm/vexpress.rst
new file mode 100644
index 00000000000..7f1bcbef078
--- /dev/null
+++ b/docs/system/arm/vexpress.rst
@@ -0,0 +1,60 @@ 
+Arm Versatile Express boards (``vexpress-a9``, ``vexpress-a15``)
+================================================================
+
+QEMU models two variants of the Arm Versatile Express development
+board family:
+
+- ``vexpress-a9`` models the combination of the Versatile Express
+  motherboard and the CoreTile Express A9x4 daughterboard
+- ``vexpress-a15`` models the combination of the Versatile Express
+  motherboard and the CoreTile Express A15x2 daughterboard
+
+Note that as this hardware does not have PCI, IDE or SCSI,
+the only available storage option is emulated SD card.
+
+Implemented devices:
+
+- PL041 audio
+- PL181 SD controller
+- PL050 keyboard and mouse
+- PL011 UARTs
+- SP804 timers
+- I2C controller
+- PL031 RTC
+- PL111 LCD display controller
+- Flash memory
+- LAN9118 ethernet
+
+Unimplemented devices:
+
+- SP810 system control block
+- PCI-express
+- USB controller (Philips ISP1761)
+- Local DAP ROM
+- CoreSight interfaces
+- PL301 AXI interconnect
+- SCC
+- System counter
+- HDLCD controller (``vexpress-a15``)
+- SP805 watchdog
+- PL341 dynamic memory controller
+- DMA330 DMA controller
+- PL354 static memory controller
+- BP147 TrustZone Protection Controller
+- TrustZone Address Space Controller
+
+Other differences between the hardware and the QEMU model:
+
+- QEMU will default to creating one CPU unless you pass a different
+  ``-smp`` argument
+- QEMU allows the amount of RAM provided to be specified with the
+  ``-m`` argument
+- QEMU defaults to providing a CPU which does not provide either
+  TrustZone or the Virtualization Extensions: if you want these you
+  must enable them with ``-machine secure=on`` and ``-machine
+  virtualization=on``
+- QEMU provides 4 virtio-mmio virtio transports; these start at
+  address ``0x10013000`` for ``vexpress-a9`` and at ``0x1c130000`` for
+  ``vexpress-a15``, and have IRQs from 40 upwards. If a dtb is
+  provided on the command line then QEMU will edit it to include
+  suitable entries describing these transports for the guest.
diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst
index d1196cbe01c..4779293d731 100644
--- a/docs/system/target-arm.rst
+++ b/docs/system/target-arm.rst
@@ -73,6 +73,7 @@  undocumented; you can get a complete list by running
    arm/integratorcp
    arm/realview
    arm/versatile
+   arm/vexpress
    arm/musicpal
    arm/nseries
    arm/orangepi
diff --git a/MAINTAINERS b/MAINTAINERS
index 1f84e3ae2c6..74cff1c3818 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -826,6 +826,7 @@  M: Peter Maydell <peter.maydell@linaro.org>
 L: qemu-arm@nongnu.org
 S: Maintained
 F: hw/arm/vexpress.c
+F: docs/system/arm/vexpress.rst
 
 Versatile PB
 M: Peter Maydell <peter.maydell@linaro.org>