Reviewed-by: Niek Linnenbank <nieklinnenb...@gmail.com>
On Mon, Mar 9, 2020 at 10:58 PM Peter Maydell <peter.mayd...@linaro.org>
wrote:
> Currently the documentation for Arm system emulator targets is in a
> single target-arm.rst. This describes only some of the boards and
> often in a fairly abbreviated fashion. Restructure it so that each
> board has its own documentation file in the docs/system/arm/
> subdirectory.
>
> This will hopefully encourage us to write board documentation that
> describes the board in detail, rather than a few brief paragraphs
> in a single long page. The table of contents should also help users
> to find the board they care about faster.
>
> Once the structure is in place we'll be able to move microvm.rst
> from the top-level docs/ directory.
>
> All the text from the old page is retained, except for the final
> paragraph ("A Linux 2.6 test image is available on the QEMU web site.
> More information is available in the QEMU mailing-list archive."),
> which is deleted. The git history shows this was originally added
> in reference to the integratorcp board (at that time the only
> Arm board that was supported), and has subsequently gradually been
> further and further separated from the integratorcp documentation
> by the insertion of other board documentation sections. It's
> extremely out of date and no longer accurate, since AFAICT there
> isn't an integratorcp kernel on the website any more; so better
> deleted than retained.
>
> Signed-off-by: Peter Maydell <peter.mayd...@linaro.org>
> ---
> A subsequent patch will add some text that at least gestures
> in the direction of some of the more obvious missing info,
> eg 64-bit boards.
> ---
> MAINTAINERS | 9 ++
> docs/system/arm/integratorcp.rst | 16 +++
> docs/system/arm/musicpal.rst | 19 +++
> docs/system/arm/nseries.rst | 33 +++++
> docs/system/arm/palm.rst | 23 ++++
> docs/system/arm/realview.rst | 34 +++++
> docs/system/arm/stellaris.rst | 26 ++++
> docs/system/arm/sx1.rst | 18 +++
> docs/system/arm/versatile.rst | 29 ++++
> docs/system/arm/xscale.rst | 29 ++++
> docs/system/target-arm.rst | 225 ++-----------------------------
> 11 files changed, 249 insertions(+), 212 deletions(-)
> create mode 100644 docs/system/arm/integratorcp.rst
> create mode 100644 docs/system/arm/musicpal.rst
> create mode 100644 docs/system/arm/nseries.rst
> create mode 100644 docs/system/arm/palm.rst
> create mode 100644 docs/system/arm/realview.rst
> create mode 100644 docs/system/arm/stellaris.rst
> create mode 100644 docs/system/arm/sx1.rst
> create mode 100644 docs/system/arm/versatile.rst
> create mode 100644 docs/system/arm/xscale.rst
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 36d0c6887a9..31a1b423df1 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -155,6 +155,7 @@ F: include/hw/cpu/a*mpcore.h
> F: disas/arm.c
> F: disas/arm-a64.cc
> F: disas/libvixl/
> +F: docs/system/target-arm.rst
>
> ARM SMMU
> M: Eric Auger <eric.au...@redhat.com>
> @@ -615,6 +616,7 @@ F: hw/arm/integratorcp.c
> F: hw/misc/arm_integrator_debug.c
> F: include/hw/misc/arm_integrator_debug.h
> F: tests/acceptance/machine_arm_integratorcp.py
> +F: docs/system/arm/integratorcp.rst
>
> MCIMX6UL EVK / i.MX6ul
> M: Peter Maydell <peter.mayd...@linaro.org>
> @@ -673,6 +675,7 @@ M: Peter Maydell <peter.mayd...@linaro.org>
> L: qemu-...@nongnu.org
> S: Odd Fixes
> F: hw/arm/musicpal.c
> +F: docs/system/arm/musicpal.rst
>
> nSeries
> M: Andrzej Zaborowski <balr...@gmail.com>
> @@ -689,6 +692,7 @@ F: include/hw/display/blizzard.h
> F: include/hw/input/tsc2xxx.h
> F: include/hw/misc/cbus.h
> F: tests/acceptance/machine_arm_n8x0.py
> +F: docs/system/arm/nseries.rst
>
> Palm
> M: Andrzej Zaborowski <balr...@gmail.com>
> @@ -698,6 +702,7 @@ S: Odd Fixes
> F: hw/arm/palm.c
> F: hw/input/tsc210x.c
> F: include/hw/input/tsc2xxx.h
> +F: docs/system/arm/palm.rst
>
> Raspberry Pi
> M: Peter Maydell <peter.mayd...@linaro.org>
> @@ -719,6 +724,7 @@ F: hw/arm/realview*
> F: hw/cpu/realview_mpcore.c
> F: hw/intc/realview_gic.c
> F: include/hw/intc/realview_gic.h
> +F: docs/system/arm/realview.rst
>
> PXA2XX
> M: Andrzej Zaborowski <balr...@gmail.com>
> @@ -738,6 +744,7 @@ F: hw/misc/max111x.c
> F: include/hw/arm/pxa.h
> F: include/hw/arm/sharpsl.h
> F: include/hw/display/tc6393xb.h
> +F: docs/system/arm/xscale.rst
>
> SABRELITE / i.MX6
> M: Peter Maydell <peter.mayd...@linaro.org>
> @@ -773,6 +780,7 @@ L: qemu-...@nongnu.org
> S: Maintained
> F: hw/*/stellaris*
> F: include/hw/input/gamepad.h
> +F: docs/system/arm/stellaris.rst
>
> Versatile Express
> M: Peter Maydell <peter.mayd...@linaro.org>
> @@ -786,6 +794,7 @@ L: qemu-...@nongnu.org
> S: Maintained
> F: hw/*/versatile*
> F: hw/misc/arm_sysctl.c
> +F: docs/system/arm/versatile.rst
>
> Virt
> M: Peter Maydell <peter.mayd...@linaro.org>
> diff --git a/docs/system/arm/integratorcp.rst
> b/docs/system/arm/integratorcp.rst
> new file mode 100644
> index 00000000000..3232b43a08b
> --- /dev/null
> +++ b/docs/system/arm/integratorcp.rst
> @@ -0,0 +1,16 @@
> +Integrator/CP (``integratorcp``)
> +================================
> +
> +The ARM Integrator/CP board is emulated with the following devices:
> +
> +- ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
> +
> +- Two PL011 UARTs
> +
> +- SMC 91c111 Ethernet adapter
> +
> +- PL110 LCD controller
> +
> +- PL050 KMI with PS/2 keyboard and mouse.
> +
> +- PL181 MultiMedia Card Interface with SD card.
> diff --git a/docs/system/arm/musicpal.rst b/docs/system/arm/musicpal.rst
> new file mode 100644
> index 00000000000..35c22212486
> --- /dev/null
> +++ b/docs/system/arm/musicpal.rst
> @@ -0,0 +1,19 @@
> +Freecom MusicPal (``musicpal``)
> +===============================
> +
> +The Freecom MusicPal internet radio emulation includes the following
> +elements:
> +
> +- Marvell MV88W8618 ARM core.
> +
> +- 32 MB RAM, 256 KB SRAM, 8 MB flash.
> +
> +- Up to 2 16550 UARTs
> +
> +- MV88W8xx8 Ethernet controller
> +
> +- MV88W8618 audio controller, WM8750 CODEC and mixer
> +
> +- 128x64 display with brightness control
> +
> +- 2 buttons, 2 navigation wheels with button function
> diff --git a/docs/system/arm/nseries.rst b/docs/system/arm/nseries.rst
> new file mode 100644
> index 00000000000..b000b6d13bb
> --- /dev/null
> +++ b/docs/system/arm/nseries.rst
> @@ -0,0 +1,33 @@
> +Nokia N800 and N810 tablets (``n800``, ``n810``)
> +================================================
>
+
> +Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 /
> +48) emulation supports the following elements:
> +
> +- Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
> +
> +- RAM and non-volatile OneNAND Flash memories
> +
> +- Display connected to EPSON remote framebuffer chip and OMAP on-chip
> + display controller and a LS041y3 MIPI DBI-C controller
> +
> +- TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen
> + controllers driven through SPI bus
> +
> +- National Semiconductor LM8323-controlled qwerty keyboard driven
> + through |I2C| bus
> +
> +- Secure Digital card connected to OMAP MMC/SD host
> +
> +- Three OMAP on-chip UARTs and on-chip STI debugging console
> +
> +- Mentor Graphics \"Inventra\" dual-role USB controller embedded in a
> + TI TUSB6010 chip - only USB host mode is supported
> +
> +- TI TMP105 temperature sensor driven through |I2C| bus
> +
> +- TI TWL92230C power management companion with an RTC on
> + |I2C| bus
> +
> +- Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
> + through CBUS
> diff --git a/docs/system/arm/palm.rst b/docs/system/arm/palm.rst
> new file mode 100644
> index 00000000000..0eabf63e0e7
> --- /dev/null
> +++ b/docs/system/arm/palm.rst
> @@ -0,0 +1,23 @@
> +Palm Tungsten|E PDA (``cheetah``)
> +=================================
> +
> +The Palm Tungsten|E PDA (codename \"Cheetah\") emulation includes the
> +following elements:
> +
> +- Texas Instruments OMAP310 System-on-chip (ARM 925T core)
> +
> +- ROM and RAM memories (ROM firmware image can be loaded with
> + -option-rom)
> +
> +- On-chip LCD controller
> +
> +- On-chip Real Time Clock
> +
> +- TI TSC2102i touchscreen controller / analog-digital converter /
> + Audio CODEC, connected through MicroWire and |I2S| busses
> +
> +- GPIO-connected matrix keypad
> +
> +- Secure Digital card connected to OMAP MMC/SD host
> +
> +- Three on-chip UARTs
> diff --git a/docs/system/arm/realview.rst b/docs/system/arm/realview.rst
> new file mode 100644
> index 00000000000..8e08eb5da16
> --- /dev/null
> +++ b/docs/system/arm/realview.rst
> @@ -0,0 +1,34 @@
> +Arm Realview boards (``realview-eb``, ``realview-eb-mpcore``,
> ``realview-pb-a8``, ``realview-pbx-a9``)
>
> +======================================================================================================
> +
> +Several variants of the ARM RealView baseboard are emulated, including
> +the EB, PB-A8 and PBX-A9. Due to interactions with the bootloader, only
> +certain Linux kernel configurations work out of the box on these boards.
> +
> +Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
> +enabled in the kernel, and expect 512M RAM. Kernels for The PBX-A9 board
> +should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
> +disabled and expect 1024M RAM.
> +
> +The following devices are emulated:
> +
> +- ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
> +
> +- ARM AMBA Generic/Distributed Interrupt Controller
> +
> +- Four PL011 UARTs
> +
> +- SMC 91c111 or SMSC LAN9118 Ethernet adapter
> +
> +- PL110 LCD controller
> +
> +- PL050 KMI with PS/2 keyboard and mouse
> +
> +- PCI host bridge
> +
> +- PCI OHCI USB controller
> +
> +- LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM
> + devices
> +
> +- PL181 MultiMedia Card Interface with SD card.
> diff --git a/docs/system/arm/stellaris.rst b/docs/system/arm/stellaris.rst
> new file mode 100644
> index 00000000000..8af4ad79c79
> --- /dev/null
> +++ b/docs/system/arm/stellaris.rst
> @@ -0,0 +1,26 @@
> +Stellaris boards (``lm3s6965evb``, ``lm3s811evb``)
> +==================================================
> +
> +The Luminary Micro Stellaris LM3S811EVB emulation includes the following
> +devices:
> +
> +- Cortex-M3 CPU core.
> +
> +- 64k Flash and 8k SRAM.
> +
> +- Timers, UARTs, ADC and |I2C| interface.
> +
> +- OSRAM Pictiva 96x16 OLED with SSD0303 controller on
> + |I2C| bus.
> +
> +The Luminary Micro Stellaris LM3S6965EVB emulation includes the
> +following devices:
> +
> +- Cortex-M3 CPU core.
> +
> +- 256k Flash and 64k SRAM.
> +
> +- Timers, UARTs, ADC, |I2C| and SSI interfaces.
> +
> +- OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via
> + SSI.
> diff --git a/docs/system/arm/sx1.rst b/docs/system/arm/sx1.rst
> new file mode 100644
> index 00000000000..321993bc098
> --- /dev/null
> +++ b/docs/system/arm/sx1.rst
> @@ -0,0 +1,18 @@
> +Siemens SX1 (``sx1``, ``sx1-v1``)
> +=================================
> +
> +The Siemens SX1 models v1 and v2 (default) basic emulation. The
> +emulation includes the following elements:
> +
> +- Texas Instruments OMAP310 System-on-chip (ARM 925T core)
> +
> +- ROM and RAM memories (ROM firmware image can be loaded with
> + -pflash) V1 1 Flash of 16MB and 1 Flash of 8MB V2 1 Flash of 32MB
> +
> +- On-chip LCD controller
> +
> +- On-chip Real Time Clock
> +
> +- Secure Digital card connected to OMAP MMC/SD host
> +
> +- Three on-chip UARTs
> diff --git a/docs/system/arm/versatile.rst b/docs/system/arm/versatile.rst
> new file mode 100644
> index 00000000000..48b6ca0a020
> --- /dev/null
> +++ b/docs/system/arm/versatile.rst
> @@ -0,0 +1,29 @@
> +Arm Versatile boards (``versatileab``, ``versatilepb``)
> +=======================================================
> +
> +The ARM Versatile baseboard is emulated with the following devices:
> +
> +- ARM926E, ARM1136 or Cortex-A8 CPU
> +
> +- PL190 Vectored Interrupt Controller
> +
> +- Four PL011 UARTs
> +
> +- SMC 91c111 Ethernet adapter
> +
> +- PL110 LCD controller
> +
> +- PL050 KMI with PS/2 keyboard and mouse.
> +
> +- PCI host bridge. Note the emulated PCI bridge only provides access
> + to PCI memory space. It does not provide access to PCI IO space. This
> + means some devices (eg. ne2k_pci NIC) are not usable, and others (eg.
> + rtl8139 NIC) are only usable when the guest drivers use the memory
> + mapped control registers.
> +
> +- PCI OHCI USB controller.
> +
> +- LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM
> + devices.
> +
> +- PL181 MultiMedia Card Interface with SD card.
> diff --git a/docs/system/arm/xscale.rst b/docs/system/arm/xscale.rst
> new file mode 100644
> index 00000000000..19da2eff352
> --- /dev/null
> +++ b/docs/system/arm/xscale.rst
> @@ -0,0 +1,29 @@
> +Sharp XScale-based PDA models (``akita``, ``borzoi``, ``spitz``,
> ``terrier``)
>
> +=============================================================================
> +
> +The XScale-based clamshell PDA models (\"Spitz\", \"Akita\", \"Borzoi\"
> +and \"Terrier\") emulation includes the following peripherals:
> +
> +- Intel PXA270 System-on-chip (ARM V5TE core)
> +
> +- NAND Flash memory
> +
> +- IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in \"Akita\"
> +
> +- On-chip OHCI USB controller
> +
> +- On-chip LCD controller
> +
> +- On-chip Real Time Clock
> +
> +- TI ADS7846 touchscreen controller on SSP bus
> +
> +- Maxim MAX1111 analog-digital converter on |I2C| bus
> +
> +- GPIO-connected keyboard controller and LEDs
> +
> +- Secure Digital card connected to PXA MMC/SD host
> +
> +- Three on-chip UARTs
> +
> +- WM8750 audio CODEC on |I2C| and |I2S| busses
> diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst
> index d2a3b44ce88..c7df6fc1f97 100644
> --- a/docs/system/target-arm.rst
> +++ b/docs/system/target-arm.rst
> @@ -3,215 +3,16 @@
> ARM System emulator
> -------------------
>
> -Use the executable ``qemu-system-arm`` to simulate a ARM machine. The
> -ARM Integrator/CP board is emulated with the following devices:
> -
> -- ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
> -
> -- Two PL011 UARTs
> -
> -- SMC 91c111 Ethernet adapter
> -
> -- PL110 LCD controller
> -
> -- PL050 KMI with PS/2 keyboard and mouse.
> -
> -- PL181 MultiMedia Card Interface with SD card.
> -
> -The ARM Versatile baseboard is emulated with the following devices:
> -
> -- ARM926E, ARM1136 or Cortex-A8 CPU
> -
> -- PL190 Vectored Interrupt Controller
> -
> -- Four PL011 UARTs
> -
> -- SMC 91c111 Ethernet adapter
> -
> -- PL110 LCD controller
> -
> -- PL050 KMI with PS/2 keyboard and mouse.
> -
> -- PCI host bridge. Note the emulated PCI bridge only provides access
> - to PCI memory space. It does not provide access to PCI IO space. This
> - means some devices (eg. ne2k_pci NIC) are not usable, and others (eg.
> - rtl8139 NIC) are only usable when the guest drivers use the memory
> - mapped control registers.
> -
> -- PCI OHCI USB controller.
> -
> -- LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM
> - devices.
> -
> -- PL181 MultiMedia Card Interface with SD card.
> -
> -Several variants of the ARM RealView baseboard are emulated, including
> -the EB, PB-A8 and PBX-A9. Due to interactions with the bootloader, only
> -certain Linux kernel configurations work out of the box on these boards.
> -
> -Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
> -enabled in the kernel, and expect 512M RAM. Kernels for The PBX-A9 board
> -should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
> -disabled and expect 1024M RAM.
> -
> -The following devices are emulated:
> -
> -- ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
> -
> -- ARM AMBA Generic/Distributed Interrupt Controller
> -
> -- Four PL011 UARTs
> -
> -- SMC 91c111 or SMSC LAN9118 Ethernet adapter
> -
> -- PL110 LCD controller
> -
> -- PL050 KMI with PS/2 keyboard and mouse
> -
> -- PCI host bridge
> -
> -- PCI OHCI USB controller
> -
> -- LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM
> - devices
> -
> -- PL181 MultiMedia Card Interface with SD card.
> -
> -The XScale-based clamshell PDA models (\"Spitz\", \"Akita\", \"Borzoi\"
> -and \"Terrier\") emulation includes the following peripherals:
> -
> -- Intel PXA270 System-on-chip (ARM V5TE core)
> -
> -- NAND Flash memory
> -
> -- IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in \"Akita\"
> -
> -- On-chip OHCI USB controller
> -
> -- On-chip LCD controller
> -
> -- On-chip Real Time Clock
> -
> -- TI ADS7846 touchscreen controller on SSP bus
> -
> -- Maxim MAX1111 analog-digital converter on |I2C| bus
> -
> -- GPIO-connected keyboard controller and LEDs
> -
> -- Secure Digital card connected to PXA MMC/SD host
> -
> -- Three on-chip UARTs
> -
> -- WM8750 audio CODEC on |I2C| and |I2S| busses
> -
> -The Palm Tungsten|E PDA (codename \"Cheetah\") emulation includes the
> -following elements:
> -
> -- Texas Instruments OMAP310 System-on-chip (ARM 925T core)
> -
> -- ROM and RAM memories (ROM firmware image can be loaded with
> - -option-rom)
> -
> -- On-chip LCD controller
> -
> -- On-chip Real Time Clock
> -
> -- TI TSC2102i touchscreen controller / analog-digital converter /
> - Audio CODEC, connected through MicroWire and |I2S| busses
> -
> -- GPIO-connected matrix keypad
> -
> -- Secure Digital card connected to OMAP MMC/SD host
> -
> -- Three on-chip UARTs
> -
> -Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 /
> -48) emulation supports the following elements:
> -
> -- Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
> -
> -- RAM and non-volatile OneNAND Flash memories
> -
> -- Display connected to EPSON remote framebuffer chip and OMAP on-chip
> - display controller and a LS041y3 MIPI DBI-C controller
> -
> -- TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen
> - controllers driven through SPI bus
> -
> -- National Semiconductor LM8323-controlled qwerty keyboard driven
> - through |I2C| bus
> -
> -- Secure Digital card connected to OMAP MMC/SD host
> -
> -- Three OMAP on-chip UARTs and on-chip STI debugging console
> -
> -- Mentor Graphics \"Inventra\" dual-role USB controller embedded in a
> - TI TUSB6010 chip - only USB host mode is supported
> -
> -- TI TMP105 temperature sensor driven through |I2C| bus
> -
> -- TI TWL92230C power management companion with an RTC on
> - |I2C| bus
> -
> -- Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
> - through CBUS
> -
> -The Luminary Micro Stellaris LM3S811EVB emulation includes the following
> -devices:
> -
> -- Cortex-M3 CPU core.
> -
> -- 64k Flash and 8k SRAM.
> -
> -- Timers, UARTs, ADC and |I2C| interface.
> -
> -- OSRAM Pictiva 96x16 OLED with SSD0303 controller on
> - |I2C| bus.
> -
> -The Luminary Micro Stellaris LM3S6965EVB emulation includes the
> -following devices:
> -
> -- Cortex-M3 CPU core.
> -
> -- 256k Flash and 64k SRAM.
> -
> -- Timers, UARTs, ADC, |I2C| and SSI interfaces.
> -
> -- OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via
> - SSI.
> -
> -The Freecom MusicPal internet radio emulation includes the following
> -elements:
> -
> -- Marvell MV88W8618 ARM core.
> -
> -- 32 MB RAM, 256 KB SRAM, 8 MB flash.
> -
> -- Up to 2 16550 UARTs
> -
> -- MV88W8xx8 Ethernet controller
> -
> -- MV88W8618 audio controller, WM8750 CODEC and mixer
> -
> -- 128x64 display with brightness control
> -
> -- 2 buttons, 2 navigation wheels with button function
> -
> -The Siemens SX1 models v1 and v2 (default) basic emulation. The
> -emulation includes the following elements:
> -
> -- Texas Instruments OMAP310 System-on-chip (ARM 925T core)
> -
> -- ROM and RAM memories (ROM firmware image can be loaded with
> - -pflash) V1 1 Flash of 16MB and 1 Flash of 8MB V2 1 Flash of 32MB
> -
> -- On-chip LCD controller
> -
> -- On-chip Real Time Clock
> -
> -- Secure Digital card connected to OMAP MMC/SD host
> -
> -- Three on-chip UARTs
> -
> -A Linux 2.6 test image is available on the QEMU web site. More
> -information is available in the QEMU mailing-list archive.
> +Use the executable ``qemu-system-arm`` to simulate a ARM machine.
> +
> +.. toctree::
> +
> + arm/integratorcp
> + arm/versatile
> + arm/realview
> + arm/xscale
> + arm/palm
> + arm/nseries
> + arm/stellaris
> + arm/musicpal
> + arm/sx1
> --
> 2.20.1
>
>
--
Niek Linnenbank
