docs: document cubieboard, emcraft-sf2, highbank, midway
v2 cover docs: document cubieboard, emcraft-sf2, highbank, midway
This patchset adds documentation of the four board models cubieboard, emcraft-sf2, highbank and midway. The documentation here is rather skeletal, being based on a quick read of sources, cover letter from original patch submission, etc.
People interested in these machines are encouraged to improve on these docs, but I would like us to at least have a stub for all the Arm boards we emulate.
For the record, as well as these we have another ten undocumented boards:
imx25-pdk, kzm, mainstone, mcimx6ul-evk, mcimx7d-sabre, nuri, smdkc210, xilinx-zynq-a9, xlnx-zcu102, z2
v2: updated cubieboard and emcraft-sf2 files to list emulated devices (thanks to Philippe for the lists of devices).
thanks
-- PMM
Peter Maydell (3):
docs: Add skeletal documentation of cubieboard
docs: Add skeletal documentation of the emcraft-sf2
docs: Add skeletal documentation of highbank and midway
docs/system/arm/cubieboard.rst | 16 ++++++++++++++++ docs/system/arm/emcraft-sf2.rst | 15 +++++++++++++++ docs/system/arm/highbank.rst | 19 +++++++++++++++++++ docs/system/target-arm.rst | 3 +++ MAINTAINERS | 3 +++ 5 files changed, 56 insertions(+) create mode 100644 docs/system/arm/cubieboard.rst create mode 100644 docs/system/arm/emcraft-sf2.rst create mode 100644 docs/system/arm/highbank.rst
Signature · 1 line
2.20.1
PATCH v2 1/3 docs: Add skeletal documentation of cubieboard
Add skeletal documentation of the cubieboard machine.
--- docs/system/arm/cubieboard.rst | 16 ++++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 18 insertions(+) create mode 100644 docs/system/arm/cubieboard.rst
docs/system/arm/cubieboard.rst new file +16 -0
@@ -0,0 +1,16 @@ +Cubietech Cubieboard (``cubieboard``) +===================================== + +The ``cubieboard`` model emulates the Cubietech Cubieboard, +which is a Cortex-A8 based single-board computer using +the AllWinner A10 SoC. + +Emulated devices: + +- Timer +- UART +- RTC +- EMAC +- SDHCI +- USB controller +- SATA controller
docs/system/target-arm.rst +1 -0
@@ -85,6 +85,7 @@ undocumented; you can get a complete list by running arm/aspeed arm/sabrelite arm/digic + arm/cubieboard arm/musicpal arm/gumstix arm/nrf
MAINTAINERS +1 -0
@@ -559,6 +559,7 @@ S: Odd Fixes F: hw/*/allwinner* F: include/hw/*/allwinner* F: hw/arm/cubieboard.c +F: docs/system/arm/cubieboard.rst Allwinner-h3 M: Niek Linnenbank <[email protected]>
Signature · 1 line
2.20.1
Re: [PATCH v2 1/3] docs: Add skeletal documentation of cubieboard
Quoted 9 lines · Peter Maydell
Add skeletal documentation of the cubieboard machine.
Signed-off-by Peter Maydell <[email protected]>--- docs/system/arm/cubieboard.rst | 16 ++++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 18 insertions(+) create mode 100644 docs/system/arm/cubieboard.rst
PATCH v2 2/3 docs: Add skeletal documentation of the emcraft-sf2
In reply to Peter MaydellAdd skeletal documentation of the emcraft-sf2 machine.
--- docs/system/arm/emcraft-sf2.rst | 15 +++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 17 insertions(+) create mode 100644 docs/system/arm/emcraft-sf2.rst
docs/system/arm/emcraft-sf2.rst new file +15 -0
@@ -0,0 +1,15 @@ +Emcraft SmartFusion2 SOM kit (``emcraft-sf2``) +============================================== + +The ``emcraft-sf2`` board emulates the SmartFusion2 SOM kit from +Emcraft (M2S010). This is a System-on-Module from EmCraft systems, +based on the SmartFusion2 SoC FPGA from Microsemi Corporation. +The SoC is based on a Cortex-M4 processor. + +Emulated devices: + +- System timer +- System registers +- SPI controller +- UART +- EMAC
docs/system/target-arm.rst +1 -0
@@ -86,6 +86,7 @@ undocumented; you can get a complete list by running arm/sabrelite arm/digic arm/cubieboard + arm/emcraft-sf2 arm/musicpal arm/gumstix arm/nrf
MAINTAINERS +1 -0
@@ -1023,6 +1023,7 @@ M: Peter Maydell <[email protected]> L: [email protected] S: Maintained F: hw/arm/msf2-som.c +F: docs/system/arm/emcraft-sf2.rst ASPEED BMCs M: Cédric Le Goater <[email protected]>
Signature · 1 line
2.20.1
Re: [PATCH v2 2/3] docs: Add skeletal documentation of the emcraft-sf2
Quoted 9 lines · Peter Maydell
Add skeletal documentation of the emcraft-sf2 machine.
Signed-off-by Peter Maydell <[email protected]>--- docs/system/arm/emcraft-sf2.rst | 15 +++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 17 insertions(+) create mode 100644 docs/system/arm/emcraft-sf2.rst
PATCH v2 3/3 docs: Add skeletal documentation of highbank and midway
In reply to Peter MaydellAdd skeletal documentation for the highbank and midway machines.
--- docs/system/arm/highbank.rst | 19 +++++++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 21 insertions(+) create mode 100644 docs/system/arm/highbank.rst
docs/system/arm/highbank.rst new file +19 -0
@@ -0,0 +1,19 @@ +Calxeda Highbank and Midway (``highbank``, ``midway``) +====================================================== + +``highbank`` is a model of the Calxeda Highbank (ECX-1000) system, +which has four Cortex-A9 cores. + +``midway`` is a model of the Calxeda Midway (ECX-2000) system, +which has four Cortex-A15 cores. + +Emulated devices: + +- L2x0 cache controller +- SP804 dual timer +- PL011 UART +- PL061 GPIOs +- PL031 RTC +- PL022 synchronous serial port controller +- AHCI +- XGMAC ethernet controllers
docs/system/target-arm.rst +1 -0
@@ -87,6 +87,7 @@ undocumented; you can get a complete list by running arm/digic arm/cubieboard arm/emcraft-sf2 + arm/highbank arm/musicpal arm/gumstix arm/nrf
MAINTAINERS +1 -0
@@ -642,6 +642,7 @@ L: [email protected] S: Odd Fixes F: hw/arm/highbank.c F: hw/net/xgmac.c +F: docs/system/arm/highbank.rst Canon DIGIC M: Antony Pavlov <[email protected]>
Signature · 1 line
2.20.1
Re: [PATCH v2 3/3] docs: Add skeletal documentation of highbank and midway
Quoted 9 lines · Peter Maydell
Add skeletal documentation for the highbank and midway machines.
Signed-off-by Peter Maydell <[email protected]>--- docs/system/arm/highbank.rst | 19 +++++++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 21 insertions(+) create mode 100644 docs/system/arm/highbank.rst
Quoted 4 lines · Peter Maydell
Peter Maydell (3):
docs: Add skeletal documentation of cubieboard
docs: Add skeletal documentation of the emcraft-sf2
docs: Add skeletal documentation of highbank and midway
r~