diff mbox series

[PATCH-for-5.2,2/4] docs/system/arm: Document the various raspi boards

Message ID 20201120152140.2493197-3-f4bug@amsat.org
State New
Headers show
Series docs/system/arm: Document raspi/tosa boards | expand

Commit Message

Philippe Mathieu-Daudé Nov. 20, 2020, 3:21 p.m. UTC 
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

Comments

Philippe Mathieu-Daudé Nov. 20, 2020, 3:24 p.m. UTC | #1 
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>
---
Peter Maydell Nov. 20, 2020, 4:48 p.m. UTC | #2 
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
Philippe Mathieu-Daudé Nov. 20, 2020, 5:09 p.m. UTC | #3 
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
>
diff mbox series

Patch

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