Skip to contentSkip to conversation

docs: document cubieboard, emcraft-sf2, highbank, midway

PATCH Superseded Peter Maydell 2 participants 6 messages Jul 5, 2021

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

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

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  |  6 ++++++
 docs/system/arm/emcraft-sf2.rst | 10 ++++++++++
 docs/system/arm/highbank.rst    | 19 +++++++++++++++++++
 docs/system/target-arm.rst      |  3 +++
 MAINTAINERS                     |  3 +++
 5 files changed, 41 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
#1 lore raw

PATCH 1/3 docs: Add skeletal documentation of cubieboard

Add skeletal documentation of the cubieboard machine.

---
 docs/system/arm/cubieboard.rst | 6 ++++++
 docs/system/target-arm.rst     | 1 +
 MAINTAINERS                    | 1 +
 3 files changed, 8 insertions(+)
 create mode 100644 docs/system/arm/cubieboard.rst
docs/system/arm/cubieboard.rst new file +6 -0
new file mode 100644
index 00000000000..2be8a278633
@@ -0,0 +1,6 @@
+Cubietech Cubieboard (``cubieboard``)
+=====================================
+
+The ``cubieboard`` model emulates the Cubietech Cubieboard,
+which is a Cortex-A8 based single-board computer using
+the AllWinner A10 SoC.
docs/system/target-arm.rst +1 -0
index 13b3eeaf076..0a3ef309472 100644
@@ -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
index cb8f3ea2c2e..76a2c608d1e 100644
@@ -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
#2 lore raw

Re: [PATCH 1/3] docs: Add skeletal documentation of cubieboard

Quoted 16 lines · Peter Maydell

Add skeletal documentation of the cubieboard machine.

---
 docs/system/arm/cubieboard.rst | 6 ++++++
 docs/system/target-arm.rst     | 1 +
 MAINTAINERS                    | 1 +
 3 files changed, 8 insertions(+)
 create mode 100644 docs/system/arm/cubieboard.rst
docs/system/arm/cubieboard.rst new file +0 -0
new file mode 100644
index 00000000000..2be8a278633

docs/system/arm/cubieboard.rst line 6

Quoted 6 lines
docs/system/arm/cubieboard.rst new file +6 -0
@@ -0,0 +1,6 @@
+Cubietech Cubieboard (``cubieboard``)
+=====================================
+
+The ``cubieboard`` model emulates the Cubietech Cubieboard,
+which is a Cortex-A8 based single-board computer using
+the AllWinner A10 SoC.

Modelled: Timer, UART, RTC, EMAC, SDHCI, USB & SATA controllers.

Quoted 25 lines
docs/system/target-arm.rst +1 -0
index 13b3eeaf076..0a3ef309472 100644
@@ -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
index cb8f3ea2c2e..76a2c608d1e 100644
@@ -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]>
#3 lore raw

PATCH 2/3 docs: Add skeletal documentation of the emcraft-sf2

In reply to Peter Maydell

Add skeletal documentation of the emcraft-sf2 machine.

---
 docs/system/arm/emcraft-sf2.rst | 10 ++++++++++
 docs/system/target-arm.rst      |  1 +
 MAINTAINERS                     |  1 +
 3 files changed, 12 insertions(+)
 create mode 100644 docs/system/arm/emcraft-sf2.rst
docs/system/arm/emcraft-sf2.rst new file +10 -0
new file mode 100644
index 00000000000..9f10b86427a
@@ -0,0 +1,10 @@
+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.
+
+At the moment only the system timer, system registers and SPI
+controller are modelled.
docs/system/target-arm.rst +1 -0
index 0a3ef309472..d316e684106 100644
@@ -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
index 76a2c608d1e..dbbd71958ac 100644
@@ -1007,6 +1007,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
#4 lore raw

Re: [PATCH 2/3] docs: Add skeletal documentation of the emcraft-sf2

Quoted 16 lines · Peter Maydell

Add skeletal documentation of the emcraft-sf2 machine.

---
 docs/system/arm/emcraft-sf2.rst | 10 ++++++++++
 docs/system/target-arm.rst      |  1 +
 MAINTAINERS                     |  1 +
 3 files changed, 12 insertions(+)
 create mode 100644 docs/system/arm/emcraft-sf2.rst
docs/system/arm/emcraft-sf2.rst new file +0 -0
new file mode 100644
index 00000000000..9f10b86427a

docs/system/arm/emcraft-sf2.rst line 10

Quoted 10 lines
docs/system/arm/emcraft-sf2.rst new file +10 -0
@@ -0,0 +1,10 @@
+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.
+
+At the moment only the system timer, system registers and SPI
+controller are modelled.

Also UART and EMAC :)

Quoted 25 lines
docs/system/target-arm.rst +1 -0
index 0a3ef309472..d316e684106 100644
@@ -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
index 76a2c608d1e..dbbd71958ac 100644
@@ -1007,6 +1007,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]>
#5 lore raw

PATCH 3/3 docs: Add skeletal documentation of highbank and midway

In reply to Peter Maydell

Add 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
new file mode 100644
index 00000000000..bb4965b367f
@@ -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
index d316e684106..569983997cf 100644
@@ -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
index dbbd71958ac..91546c0e943 100644
@@ -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