[PATCH-for-5.2 0/4] docs/system/arm: Document raspi/tosa boards
- Deprecate raspi2/raspi3 machine aliases - Document the Raspberry Pi boards - Document LED on OpenPOWER Witherspoon - Document Sharp Zaurus SL-6000 Tosa Philippe Mathieu-Daudé (4): docs/system: Deprecate raspi2/raspi3 machine aliases docs/system/arm: Document the various raspi boards docs/system/arm: Document OpenPOWER Witherspoon BMC model Front LEDs docs/system/arm: Document the Sharp Zaurus SL-6000 docs/system/arm/aspeed.rst | 1 + docs/system/arm/raspi.rst | 44 ++++++++++++++++++++++++++++++++++++++ docs/system/arm/xscale.rst | 13 ++++++----- docs/system/deprecated.rst | 7 ++++++ docs/system/target-arm.rst | 1 + 5 files changed, 61 insertions(+), 5 deletions(-) create mode 100644 docs/system/arm/raspi.rst -- 2.26.2
Since commit aa35ec2213b ("hw/arm/raspi: Use more specific machine names") the raspi2/raspi3 machines have been renamed as raspi2b/raspi3b. Note, rather than the raspi3b, the raspi3ap introduced in commit 5be94252d34 ("hw/arm/raspi: Add the Raspberry Pi 3 model A+") is a closer match to what QEMU models, but only provides 512 MB of RAM. As more Raspberry Pi 2/3 models are emulated, in order to avoid confusion, deprecate the raspi2/raspi3 machine aliases. ACKed-by: Peter Krempa <pkrempa@redhat.com> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/deprecated.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst index d98464098f5..d1bc03d7e61 100644 --- a/docs/system/deprecated.rst +++ b/docs/system/deprecated.rst @@ -346,6 +346,13 @@ This machine has been renamed ``fuloong2e``. These machine types are very old and likely can not be used for live migration from old QEMU versions anymore. A newer machine type should be used instead. +Raspberry Pi ``raspi2`` and ``raspi3`` machines (since 5.2) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The Raspberry Pi machines come in various models (A, A+, B, B+). To be able +to distinct which model is used, the ``raspi2`` and ``raspi3`` machines have +been respectively renamed ``raspi2b`` and ``raspi3b``. + Device options -------------- -- 2.26.2
On Fri, 20 Nov 2020 at 15:21, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
Since commit aa35ec2213b ("hw/arm/raspi: Use more specific machine names") the raspi2/raspi3 machines have been renamed as raspi2b/raspi3b.
Note, rather than the raspi3b, the raspi3ap introduced in commit 5be94252d34 ("hw/arm/raspi: Add the Raspberry Pi 3 model A+") is a closer match to what QEMU models, but only provides 512 MB of RAM.
As more Raspberry Pi 2/3 models are emulated, in order to avoid confusion, deprecate the raspi2/raspi3 machine aliases.
ACKed-by: Peter Krempa <pkrempa@redhat.com> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/deprecated.rst | 7 +++++++ 1 file changed, 7 insertions(+)
diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst index d98464098f5..d1bc03d7e61 100644 --- a/docs/system/deprecated.rst +++ b/docs/system/deprecated.rst @@ -346,6 +346,13 @@ This machine has been renamed ``fuloong2e``. These machine types are very old and likely can not be used for live migration from old QEMU versions anymore. A newer machine type should be used instead.
+Raspberry Pi ``raspi2`` and ``raspi3`` machines (since 5.2) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The Raspberry Pi machines come in various models (A, A+, B, B+). To be able +to distinct which model is used, the ``raspi2`` and ``raspi3`` machines have
"to distinguish which model QEMU is implementing"
+been respectively renamed ``raspi2b`` and ``raspi3b``.
"been renamed ``raspi2b`` and ``raspi3b`` respectively" (or just drop 'respectively' altogether and assume the reader can figure out which is which ;-)) Otherwise Reviewed-by: Peter Maydell <peter.maydell@linaro.org> thanks -- PMM
Document the following Raspberry Pi models: - raspi0 Raspberry Pi Zero (revision 1.2) - raspi1ap Raspberry Pi A+ (revision 1.1) - raspi2b Raspberry Pi 2B (revision 1.1) - raspi3ap Raspberry Pi 3A+ (revision 1.0) - raspi3b Raspberry Pi 3B (revision 1.2) Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/raspi.rst | 44 ++++++++++++++++++++++++++++++++++++++ docs/system/target-arm.rst | 1 + 2 files changed, 45 insertions(+) create mode 100644 docs/system/arm/raspi.rst diff --git a/docs/system/arm/raspi.rst b/docs/system/arm/raspi.rst new file mode 100644 index 00000000000..b19284e4481 --- /dev/null +++ b/docs/system/arm/raspi.rst @@ -0,0 +1,44 @@ +Raspberry Pi boards (``raspi0``, ``raspi1ap``, ``raspi2b``, ``raspi3ap``, ``raspi3b``) +====================================================================================== + + +QEMU provides models the following Raspberry Pi boards: + +``raspi0`` and ``raspi1ap`` + ARM1176JZF-S core, 512 MiB of RAM +``raspi2b`` + Cortex-A7 (4 cores), 1 GiB of RAM +``raspi3ap`` + Cortex-A53 (4 cores), 512 MiB of RAM +``raspi3b`` + Cortex-A53 (4 cores), 1 GiB of RAM + + +Implemented devices +------------------- + + * ARM1176JZF-S, Cortex-A7 or Cortex-A53 CPU + * Interrupt controller + * DMA controller + * Clock and reset controller (CPRMAN) + * System Timer + * GPIO controller + * Serial ports (BCM2835 AUX - 16550 based - and PL011) + * Random Number Generator (RNG) + * Frame Buffer + * USB host (USBH) + * GPIO controller + * SD/MMC host controller + * SoC thermal sensor + * USB2 host controller (DWC2 and MPHI) + * MailBox controller (MBOX) + * VideoCore firmware (property) + + +Missing devices +--------------- + + * Peripheral SPI controller (SPI) + * Analog to Digital Converter (ADC) + * Pulse Width Modulation (PWM) + * Security features diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index a0d5c57799c..bde4b8e044e 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -90,6 +90,7 @@ undocumented; you can get a complete list by running arm/nuvoton arm/orangepi arm/palm + arm/raspi arm/xscale arm/collie arm/sx1 -- 2.26.2
On 11/20/20 4:21 PM, Philippe Mathieu-Daudé wrote:
Document the following Raspberry Pi models:
- raspi0 Raspberry Pi Zero (revision 1.2) - raspi1ap Raspberry Pi A+ (revision 1.1) - raspi2b Raspberry Pi 2B (revision 1.1) - raspi3ap Raspberry Pi 3A+ (revision 1.0) - raspi3b Raspberry Pi 3B (revision 1.2)
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/raspi.rst | 44 ++++++++++++++++++++++++++++++++++++++ docs/system/target-arm.rst | 1 + 2 files changed, 45 insertions(+) create mode 100644 docs/system/arm/raspi.rst
diff --git a/docs/system/arm/raspi.rst b/docs/system/arm/raspi.rst new file mode 100644 index 00000000000..b19284e4481 --- /dev/null +++ b/docs/system/arm/raspi.rst @@ -0,0 +1,44 @@ +Raspberry Pi boards (``raspi0``, ``raspi1ap``, ``raspi2b``, ``raspi3ap``, ``raspi3b``) +====================================================================================== + + +QEMU provides models the following Raspberry Pi boards: + +``raspi0`` and ``raspi1ap`` + ARM1176JZF-S core, 512 MiB of RAM +``raspi2b`` + Cortex-A7 (4 cores), 1 GiB of RAM +``raspi3ap`` + Cortex-A53 (4 cores), 512 MiB of RAM +``raspi3b`` + Cortex-A53 (4 cores), 1 GiB of RAM + + +Implemented devices +------------------- + + * ARM1176JZF-S, Cortex-A7 or Cortex-A53 CPU + * Interrupt controller + * DMA controller + * Clock and reset controller (CPRMAN) + * System Timer + * GPIO controller + * Serial ports (BCM2835 AUX - 16550 based - and PL011) + * Random Number Generator (RNG) + * Frame Buffer + * USB host (USBH) + * GPIO controller + * SD/MMC host controller + * SoC thermal sensor + * USB2 host controller (DWC2 and MPHI) + * MailBox controller (MBOX) + * VideoCore firmware (property) + + +Missing devices +--------------- + + * Peripheral SPI controller (SPI) + * Analog to Digital Converter (ADC) + * Pulse Width Modulation (PWM) + * Security features diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index a0d5c57799c..bde4b8e044e 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -90,6 +90,7 @@ undocumented; you can get a complete list by running arm/nuvoton arm/orangepi arm/palm + arm/raspi arm/xscale arm/collie arm/sx1
I forgot this hunk... I'll wait for review before respining. -- >8 -- --- a/MAINTAINERS +++ b/MAINTAINERS @@ -801,6 +801,7 @@ F: hw/arm/raspi_platform.h F: hw/*/bcm283* F: include/hw/arm/raspi* F: include/hw/*/bcm283* +F: docs/system/arm/raspi.rst Real View M: Peter Maydell <peter.maydell@linaro.org> ---
On Fri, 20 Nov 2020 at 15:21, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
Document the following Raspberry Pi models:
- raspi0 Raspberry Pi Zero (revision 1.2) - raspi1ap Raspberry Pi A+ (revision 1.1) - raspi2b Raspberry Pi 2B (revision 1.1) - raspi3ap Raspberry Pi 3A+ (revision 1.0) - raspi3b Raspberry Pi 3B (revision 1.2)
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/raspi.rst | 44 ++++++++++++++++++++++++++++++++++++++ docs/system/target-arm.rst | 1 + 2 files changed, 45 insertions(+) create mode 100644 docs/system/arm/raspi.rst
diff --git a/docs/system/arm/raspi.rst b/docs/system/arm/raspi.rst new file mode 100644 index 00000000000..b19284e4481 --- /dev/null +++ b/docs/system/arm/raspi.rst @@ -0,0 +1,44 @@ +Raspberry Pi boards (``raspi0``, ``raspi1ap``, ``raspi2b``, ``raspi3ap``, ``raspi3b``) +====================================================================================== + + +QEMU provides models the following Raspberry Pi boards:
"models of"
+ +``raspi0`` and ``raspi1ap`` + ARM1176JZF-S core, 512 MiB of RAM +``raspi2b`` + Cortex-A7 (4 cores), 1 GiB of RAM +``raspi3ap`` + Cortex-A53 (4 cores), 512 MiB of RAM +``raspi3b`` + Cortex-A53 (4 cores), 1 GiB of RAM + + +Implemented devices +------------------- + + * ARM1176JZF-S, Cortex-A7 or Cortex-A53 CPU + * Interrupt controller + * DMA controller + * Clock and reset controller (CPRMAN) + * System Timer + * GPIO controller + * Serial ports (BCM2835 AUX - 16550 based - and PL011) + * Random Number Generator (RNG) + * Frame Buffer + * USB host (USBH) + * GPIO controller + * SD/MMC host controller + * SoC thermal sensor + * USB2 host controller (DWC2 and MPHI) + * MailBox controller (MBOX) + * VideoCore firmware (property) + + +Missing devices +--------------- + + * Peripheral SPI controller (SPI) + * Analog to Digital Converter (ADC) + * Pulse Width Modulation (PWM) + * Security features
"Security features" is a bit vague; could we be more precise? Otherwise Reviewed-by: Peter Maydell <peter.maydell@linaro.org> thanks -- PMM
On 11/20/20 5:48 PM, Peter Maydell wrote:
On Fri, 20 Nov 2020 at 15:21, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
Document the following Raspberry Pi models:
- raspi0 Raspberry Pi Zero (revision 1.2) - raspi1ap Raspberry Pi A+ (revision 1.1) - raspi2b Raspberry Pi 2B (revision 1.1) - raspi3ap Raspberry Pi 3A+ (revision 1.0) - raspi3b Raspberry Pi 3B (revision 1.2)
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/raspi.rst | 44 ++++++++++++++++++++++++++++++++++++++ docs/system/target-arm.rst | 1 + 2 files changed, 45 insertions(+) create mode 100644 docs/system/arm/raspi.rst
diff --git a/docs/system/arm/raspi.rst b/docs/system/arm/raspi.rst new file mode 100644 index 00000000000..b19284e4481 --- /dev/null +++ b/docs/system/arm/raspi.rst @@ -0,0 +1,44 @@ +Raspberry Pi boards (``raspi0``, ``raspi1ap``, ``raspi2b``, ``raspi3ap``, ``raspi3b``) +====================================================================================== + + +QEMU provides models the following Raspberry Pi boards:
"models of"
+ +``raspi0`` and ``raspi1ap`` + ARM1176JZF-S core, 512 MiB of RAM +``raspi2b`` + Cortex-A7 (4 cores), 1 GiB of RAM +``raspi3ap`` + Cortex-A53 (4 cores), 512 MiB of RAM +``raspi3b`` + Cortex-A53 (4 cores), 1 GiB of RAM + + +Implemented devices +------------------- + + * ARM1176JZF-S, Cortex-A7 or Cortex-A53 CPU + * Interrupt controller + * DMA controller + * Clock and reset controller (CPRMAN) + * System Timer + * GPIO controller + * Serial ports (BCM2835 AUX - 16550 based - and PL011) + * Random Number Generator (RNG) + * Frame Buffer + * USB host (USBH) + * GPIO controller + * SD/MMC host controller + * SoC thermal sensor + * USB2 host controller (DWC2 and MPHI) + * MailBox controller (MBOX) + * VideoCore firmware (property) + + +Missing devices +--------------- + + * Peripheral SPI controller (SPI) + * Analog to Digital Converter (ADC) + * Pulse Width Modulation (PWM) + * Security features
"Security features" is a bit vague; could we be more precise?
I used Nuvoton as template. I'll remove :)
Otherwise Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
thanks -- PMM
Document the 3 front LEDs modeled on the OpenPOWER Witherspoon BMC (see commit 7cfbde5ea1c "hw/arm/aspeed: Add the 3 front LEDs drived by the PCA9552 #1"). Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/aspeed.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/system/arm/aspeed.rst b/docs/system/arm/aspeed.rst index b7a176659cb..690bada7842 100644 --- a/docs/system/arm/aspeed.rst +++ b/docs/system/arm/aspeed.rst @@ -47,6 +47,7 @@ Supported devices * GPIO Controller (Master only) * UART * Ethernet controllers + * Front LEDs (PCA9552 on I2C bus) Missing devices -- 2.26.2
On 11/20/20 4:21 PM, Philippe Mathieu-Daudé wrote:
Document the 3 front LEDs modeled on the OpenPOWER Witherspoon BMC (see commit 7cfbde5ea1c "hw/arm/aspeed: Add the 3 front LEDs drived by the PCA9552 #1").
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Cédric Le Goater <clg@kaod.org> Thanks, C.
--- docs/system/arm/aspeed.rst | 1 + 1 file changed, 1 insertion(+)
diff --git a/docs/system/arm/aspeed.rst b/docs/system/arm/aspeed.rst index b7a176659cb..690bada7842 100644 --- a/docs/system/arm/aspeed.rst +++ b/docs/system/arm/aspeed.rst @@ -47,6 +47,7 @@ Supported devices * GPIO Controller (Master only) * UART * Ethernet controllers + * Front LEDs (PCA9552 on I2C bus)
Missing devices
List the 'tosa' machine with the XScale-based PDAs models. Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/xscale.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/system/arm/xscale.rst b/docs/system/arm/xscale.rst index 89ec93e904e..2dd2f8f9a56 100644 --- a/docs/system/arm/xscale.rst +++ b/docs/system/arm/xscale.rst @@ -1,16 +1,19 @@ -Sharp XScale-based PDA models (``akita``, ``borzoi``, ``spitz``, ``terrier``) -============================================================================= +Sharp XScale-based PDA models (``tosa``, ``spitz``, ``akita``, ``borzoi``, ``terrier``) +======================================================================================= + +The Sharp Zaurus SL-6000 (``tosa``), released in 2005, was a PDA based on the +PXA255. The XScale-based clamshell PDA models (\"Spitz\", \"Akita\", \"Borzoi\" and \"Terrier\") emulation includes the following peripherals: -- Intel PXA270 System-on-chip (ARMv5TE core) +- Intel PXA255/PXA270 System-on-chip (ARMv5TE core) -- NAND Flash memory +- NAND Flash memory - not in \"Tosa\" - IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in \"Akita\" -- On-chip OHCI USB controller +- On-chip OHCI USB controller - not in \"Tosa\" - On-chip LCD controller -- 2.26.2
On Fri, 20 Nov 2020 at 15:22, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
List the 'tosa' machine with the XScale-based PDAs models.
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/xscale.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/docs/system/arm/xscale.rst b/docs/system/arm/xscale.rst index 89ec93e904e..2dd2f8f9a56 100644 --- a/docs/system/arm/xscale.rst +++ b/docs/system/arm/xscale.rst @@ -1,16 +1,19 @@ -Sharp XScale-based PDA models (``akita``, ``borzoi``, ``spitz``, ``terrier``) -============================================================================= +Sharp XScale-based PDA models (``tosa``, ``spitz``, ``akita``, ``borzoi``, ``terrier``) +=======================================================================================
These were in alphabetical order -- why the rearrangement ?
+ +The Sharp Zaurus SL-6000 (``tosa``), released in 2005, was a PDA based on the +PXA255.
The XScale-based clamshell PDA models (\"Spitz\", \"Akita\", \"Borzoi\" and \"Terrier\") emulation includes the following peripherals:
If you want to add tosa to this file (which seems reasonable) then you need to rewrite this para that introduces the bulleted list because it currently only describes spitz/akita/borzoi/terrier, so that it is instead a suitable introductory paragraph that covers all of the boards.
-- Intel PXA270 System-on-chip (ARMv5TE core) +- Intel PXA255/PXA270 System-on-chip (ARMv5TE core)
-- NAND Flash memory +- NAND Flash memory - not in \"Tosa\"
- IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in \"Akita\"
-- On-chip OHCI USB controller +- On-chip OHCI USB controller - not in \"Tosa\"
- On-chip LCD controller
thanks -- PMM
On 11/20/20 5:52 PM, Peter Maydell wrote:
On Fri, 20 Nov 2020 at 15:22, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
List the 'tosa' machine with the XScale-based PDAs models.
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> --- docs/system/arm/xscale.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/docs/system/arm/xscale.rst b/docs/system/arm/xscale.rst index 89ec93e904e..2dd2f8f9a56 100644 --- a/docs/system/arm/xscale.rst +++ b/docs/system/arm/xscale.rst @@ -1,16 +1,19 @@ -Sharp XScale-based PDA models (``akita``, ``borzoi``, ``spitz``, ``terrier``) -============================================================================= +Sharp XScale-based PDA models (``tosa``, ``spitz``, ``akita``, ``borzoi``, ``terrier``) +=======================================================================================
These were in alphabetical order -- why the rearrangement ?
Ah I didn't notice, I sorted by chronological order. I'll add tosa at the end (alphabetically last).
+ +The Sharp Zaurus SL-6000 (``tosa``), released in 2005, was a PDA based on the +PXA255.
The XScale-based clamshell PDA models (\"Spitz\", \"Akita\", \"Borzoi\" and \"Terrier\") emulation includes the following peripherals:
If you want to add tosa to this file (which seems reasonable) then you need to rewrite this para that introduces the bulleted list because it currently only describes spitz/akita/borzoi/terrier, so that it is instead a suitable introductory paragraph that covers all of the boards.
OK, I think added \"Tosa\" at the end is enough.
-- Intel PXA270 System-on-chip (ARMv5TE core) +- Intel PXA255/PXA270 System-on-chip (ARMv5TE core)
-- NAND Flash memory +- NAND Flash memory - not in \"Tosa\"
- IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in \"Akita\"
-- On-chip OHCI USB controller +- On-chip OHCI USB controller - not in \"Tosa\"
- On-chip LCD controller
thanks -- PMM
participants (3)
-
Cédric Le Goater -
Peter Maydell -
Philippe Mathieu-Daudé