Re: [PATCH qemu v3 0/2] Add minimal support for the B-L475E-IOT01A board

[Peter Maydell]

On Thu, 14 Dec 2023 at 15:23, ~inesvarhol <inesvarhol@git.sr.ht> wrote:
>
> This patch adds a new STM32L4x5 SoC, it is necessary to add support for
> the B-L475E-IOT01A board.
> The implementation is derived from the STM32F405 SoC and NetduinoPlus2
> board.
> The implementation contains no peripherals, only memory regions are
> implemented.
>
> Sorry about the inconsistency in licenses in v2, I changed them.
> Should I clarify anything further? Thank you.
>
> Changes from v1 to v3:
> Changing the MIT license to GPL.
>
> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
> Signed-off-by: Arnaud Minier <arnaud.minier@telecom-paris.fr>
> Signed-off-by: Inès Varhol <ines.varhol@telecom-paris.fr>
>
> Inès Varhol (2):
>   hw/arm: Add minimal support for the STM32L4x5 SoC
>   hw/arm: Add minimal support for the B-L475E-IOT01A board
>
>  MAINTAINERS                             |  15 ++
>  configs/devices/arm-softmmu/default.mak |   1 +
>  hw/arm/Kconfig                          |  11 +
>  hw/arm/b-l475e-iot01a.c                 |  70 +++++++
>  hw/arm/meson.build                      |   2 +
>  hw/arm/stm32l4x5_soc.c                  | 268 ++++++++++++++++++++++++
>  include/hw/arm/stm32l4x5_soc.h          |  59 ++++++

Can we have some documentation for the new board model, please?
That should be a new file under docs/system/arm/, that you
then list in docs/system/target-arm.rst (note the comment there
about what order the ToC should be in). The docs don't have to
be super comprehensive, but should at least:
 * describe what the board is
 * briefly list the supported devices
 * list any missing features or other limitations
 * describe any machine-specific options (you don't have any yet)
 * if there is an easy open source guest that will run on the board,
   some instructions for how to do that (this part isn't mandatory)

docs/system/arm/orangepi.rst is a good example of the format/structure.

(If you pass configure '--enable-docs' that will ensure that it
builds documentation and doesn't skip it because you're missing
a dependency.)

Then subsequent followon patchsets that update the model to
add new devices etc will likely also patch the docs to add
items to the "supported" list.

thanks
-- PMM