diff mbox series

[5/5] docs/system: Document Musca boards

Message ID 20200507151819.28444-6-peter.maydell@linaro.org
State Superseded
Headers show
Series docs/system: Document some arm board models | expand

Commit Message

Peter Maydell May 7, 2020, 3:18 p.m. UTC
Provide a minimal documentation of the Musca boards.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

---
 docs/system/arm/musca.rst  | 31 +++++++++++++++++++++++++++++++
 docs/system/target-arm.rst |  1 +
 MAINTAINERS                |  1 +
 3 files changed, 33 insertions(+)
 create mode 100644 docs/system/arm/musca.rst

-- 
2.20.1

Comments

Edgar E. Iglesias May 14, 2020, 1:56 p.m. UTC | #1
On Thu, May 07, 2020 at 04:18:19PM +0100, Peter Maydell wrote:
> Provide a minimal documentation of the Musca boards.


Reviewed-by: Edgar E. Iglesias <edgar.iglesias@xilinx.com>




> 

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

> ---

>  docs/system/arm/musca.rst  | 31 +++++++++++++++++++++++++++++++

>  docs/system/target-arm.rst |  1 +

>  MAINTAINERS                |  1 +

>  3 files changed, 33 insertions(+)

>  create mode 100644 docs/system/arm/musca.rst

> 

> diff --git a/docs/system/arm/musca.rst b/docs/system/arm/musca.rst

> new file mode 100644

> index 00000000000..8375c5008d5

> --- /dev/null

> +++ b/docs/system/arm/musca.rst

> @@ -0,0 +1,31 @@

> +Arm Musca boards (``musca-a``, ``musca-b1``)

> +============================================

> +

> +The Arm Musca development boards are a reference implementation

> +of a system using the SSE-200 subsystem for embedded. They are

> +dual Cortex-M33 systems.

> +

> +QEMU provides models of the A and B1 variants of this board.

> +

> +Unimplemented devices:

> +

> +- SPI

> +- |I2C|

> +- |I2S|

> +- PWM

> +- QSPI

> +- Timer

> +- SCC

> +- GPIO

> +- eFlash

> +- MHU

> +- PVT

> +- SDIO

> +- CryptoCell

> +

> +Note that (like the real hardware) the Musca-A machine is

> +asymmetric: CPU 0 does not have the FPU or DSP extensions,

> +but CPU 1 does. Also like the real hardware, the memory maps

> +for the A and B1 variants differ significantly, so guest

> +software must be built for the right variant.

> +

> diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst

> index 15bcf9f81f0..1b86b93c346 100644

> --- a/docs/system/target-arm.rst

> +++ b/docs/system/target-arm.rst

> @@ -72,6 +72,7 @@ undocumented; you can get a complete list by running

>  

>     arm/integratorcp

>     arm/mps2

> +   arm/musca

>     arm/realview

>     arm/versatile

>     arm/vexpress

> diff --git a/MAINTAINERS b/MAINTAINERS

> index ea7bdd359e0..f8e0fdb4ef2 100644

> --- a/MAINTAINERS

> +++ b/MAINTAINERS

> @@ -706,6 +706,7 @@ M: Peter Maydell <peter.maydell@linaro.org>

>  L: qemu-arm@nongnu.org

>  S: Maintained

>  F: hw/arm/musca.c

> +F: docs/system/arm/musca.rst

>  

>  Musicpal

>  M: Jan Kiszka <jan.kiszka@web.de>

> -- 

> 2.20.1

> 

>
Philippe Mathieu-Daudé May 15, 2020, 7:56 a.m. UTC | #2
On 5/7/20 5:18 PM, Peter Maydell wrote:
> Provide a minimal documentation of the Musca boards.

> 

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

> ---

>   docs/system/arm/musca.rst  | 31 +++++++++++++++++++++++++++++++

>   docs/system/target-arm.rst |  1 +

>   MAINTAINERS                |  1 +

>   3 files changed, 33 insertions(+)

>   create mode 100644 docs/system/arm/musca.rst

> 

> diff --git a/docs/system/arm/musca.rst b/docs/system/arm/musca.rst

> new file mode 100644

> index 00000000000..8375c5008d5

> --- /dev/null

> +++ b/docs/system/arm/musca.rst

> @@ -0,0 +1,31 @@

> +Arm Musca boards (``musca-a``, ``musca-b1``)

> +============================================

> +

> +The Arm Musca development boards are a reference implementation

> +of a system using the SSE-200 subsystem for embedded.


Maybe nitpicking, but this sentence seems unfinished.

" ... for embedded [?]."

Maybe triplicate "systems" again?

> They are

> +dual Cortex-M33 systems.

> +

> +QEMU provides models of the A and B1 variants of this board.

> +

> +Unimplemented devices:

> +

> +- SPI

> +- |I2C|

> +- |I2S|

> +- PWM

> +- QSPI

> +- Timer

> +- SCC

> +- GPIO

> +- eFlash

> +- MHU

> +- PVT

> +- SDIO

> +- CryptoCell

> +

> +Note that (like the real hardware) the Musca-A machine is

> +asymmetric: CPU 0 does not have the FPU or DSP extensions,

> +but CPU 1 does. Also like the real hardware, the memory maps

> +for the A and B1 variants differ significantly, so guest

> +software must be built for the right variant.

> +

> diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst

> index 15bcf9f81f0..1b86b93c346 100644

> --- a/docs/system/target-arm.rst

> +++ b/docs/system/target-arm.rst

> @@ -72,6 +72,7 @@ undocumented; you can get a complete list by running

>   

>      arm/integratorcp

>      arm/mps2

> +   arm/musca

>      arm/realview

>      arm/versatile

>      arm/vexpress

> diff --git a/MAINTAINERS b/MAINTAINERS

> index ea7bdd359e0..f8e0fdb4ef2 100644

> --- a/MAINTAINERS

> +++ b/MAINTAINERS

> @@ -706,6 +706,7 @@ M: Peter Maydell <peter.maydell@linaro.org>

>   L: qemu-arm@nongnu.org

>   S: Maintained

>   F: hw/arm/musca.c

> +F: docs/system/arm/musca.rst

>   

>   Musicpal

>   M: Jan Kiszka <jan.kiszka@web.de>

>
Peter Maydell May 15, 2020, 8:48 a.m. UTC | #3
On Fri, 15 May 2020 at 08:56, Philippe Mathieu-Daudé <philmd@redhat.com> wrote:
>

> On 5/7/20 5:18 PM, Peter Maydell wrote:

> > Provide a minimal documentation of the Musca boards.

> >

> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>


> > --- /dev/null

> > +++ b/docs/system/arm/musca.rst

> > @@ -0,0 +1,31 @@

> > +Arm Musca boards (``musca-a``, ``musca-b1``)

> > +============================================

> > +

> > +The Arm Musca development boards are a reference implementation

> > +of a system using the SSE-200 subsystem for embedded.

>

> Maybe nitpicking, but this sentence seems unfinished.

>

> " ... for embedded [?]."


That's the name of the IP block:
https://developer.arm.com/docs/101104/latest/introduction/about-the-sse-200

I guess it ought to be capitalized: "SSE-200 Subsystem for Embedded".

thanks
-- PMM
Philippe Mathieu-Daudé May 15, 2020, 9:06 a.m. UTC | #4
On 5/15/20 10:48 AM, Peter Maydell wrote:
> On Fri, 15 May 2020 at 08:56, Philippe Mathieu-Daudé <philmd@redhat.com> wrote:

>>

>> On 5/7/20 5:18 PM, Peter Maydell wrote:

>>> Provide a minimal documentation of the Musca boards.

>>>

>>> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

> 

>>> --- /dev/null

>>> +++ b/docs/system/arm/musca.rst

>>> @@ -0,0 +1,31 @@

>>> +Arm Musca boards (``musca-a``, ``musca-b1``)

>>> +============================================

>>> +

>>> +The Arm Musca development boards are a reference implementation

>>> +of a system using the SSE-200 subsystem for embedded.

>>

>> Maybe nitpicking, but this sentence seems unfinished.

>>

>> " ... for embedded [?]."

> 

> That's the name of the IP block:

> https://developer.arm.com/docs/101104/latest/introduction/about-the-sse-200

> 

> I guess it ought to be capitalized: "SSE-200 Subsystem for Embedded".


Ah yes, it is clearer.

> 

> thanks

> -- PMM

>
Alex Bennée May 15, 2020, 9:56 a.m. UTC | #5
Peter Maydell <peter.maydell@linaro.org> writes:

> Provide a minimal documentation of the Musca boards.

>

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>


Reviewed-by: Alex Bennée <alex.bennee@linaro.org>


-- 
Alex Bennée
diff mbox series

Patch

diff --git a/docs/system/arm/musca.rst b/docs/system/arm/musca.rst
new file mode 100644
index 00000000000..8375c5008d5
--- /dev/null
+++ b/docs/system/arm/musca.rst
@@ -0,0 +1,31 @@ 
+Arm Musca boards (``musca-a``, ``musca-b1``)
+============================================
+
+The Arm Musca development boards are a reference implementation
+of a system using the SSE-200 subsystem for embedded. They are
+dual Cortex-M33 systems.
+
+QEMU provides models of the A and B1 variants of this board.
+
+Unimplemented devices:
+
+- SPI
+- |I2C|
+- |I2S|
+- PWM
+- QSPI
+- Timer
+- SCC
+- GPIO
+- eFlash
+- MHU
+- PVT
+- SDIO
+- CryptoCell
+
+Note that (like the real hardware) the Musca-A machine is
+asymmetric: CPU 0 does not have the FPU or DSP extensions,
+but CPU 1 does. Also like the real hardware, the memory maps
+for the A and B1 variants differ significantly, so guest
+software must be built for the right variant.
+
diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst
index 15bcf9f81f0..1b86b93c346 100644
--- a/docs/system/target-arm.rst
+++ b/docs/system/target-arm.rst
@@ -72,6 +72,7 @@  undocumented; you can get a complete list by running
 
    arm/integratorcp
    arm/mps2
+   arm/musca
    arm/realview
    arm/versatile
    arm/vexpress
diff --git a/MAINTAINERS b/MAINTAINERS
index ea7bdd359e0..f8e0fdb4ef2 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -706,6 +706,7 @@  M: Peter Maydell <peter.maydell@linaro.org>
 L: qemu-arm@nongnu.org
 S: Maintained
 F: hw/arm/musca.c
+F: docs/system/arm/musca.rst
 
 Musicpal
 M: Jan Kiszka <jan.kiszka@web.de>