[collab-hwm] Port GD32 to HWMv2 (ARM only)

[gmarull]

Note: RISC-V part skipped, it looks like RISC-V soc/ folder will need a bit of love first.

Contains commits from
#67147
#67355

[nordicjm]

SoC and board changes look good, not looked at python file

[gmarull]

Note: compliance failure is a false positive

 Found references to undefined Kconfig symbols. If any of these are false
positives, then add them to UNDEF_KCONFIG_WHITELIST in /home/runner/work/zephyr/zephyr/./scripts/ci/check_compliance.py.

If the reference is for a comment like /* CONFIG_FOO_* */ (or
/* CONFIG_FOO_*_... */), then please use exactly that form (with the '*'). The
CI check knows not to flag it.

More generally, a reference followed by $, @, {, *, or ## will never be
flagged.

CONFIG_BOARD_                              scripts/utils/board_v1_to_v2.py:107

[fabiobaltieri]

Cool, wondering if the documentation include files could be generated automatically by aggregating the board.yaml information and grouping by vendor there, but that's probably a small project in itself

[nandojve]

Hi @gmarull ,

Not sure if compliance is a false positive here.

[gmarull]

Hi @gmarull ,

Not sure if compliance is a false positive here.

It is, CONFIG_BOARD_ is part of a regex in the migration script.

[tejlmand]

lgtm ❤️

[tejlmand]

It is, CONFIG_BOARD_ is part of a regex in the migration script.

so should be added to the list here:

zephyr/scripts/ci/check_compliance.py

Lines 612 to 617 in 603c3af

	# Many of these are symbols used as examples. Note that the list is sorted
	# alphabetically, and skips the CONFIG_ prefix.
	UNDEF_KCONFIG_WHITELIST = {
	"ALSO_MISSING",
	"APP_LINK_WITH_",
	"APP_LOG_LEVEL", # Application log level is not detected correctly as

[kartben]

Suggested change

	ARM Holdings Boards
	Arm Holdings Boards

[kartben]

Also, can we just get rid of the " Boards" suffix? It shouldn't be necessary to repeat as the TOC hierarchy already conveys that information and this clutters the navigation tree quite a bit (see v1 below)

[gmarull]

done, but used "ARM Ltd." as in vendor-prefixes.txt

[kartben]

Is it time we start looking at Sphinx/python tooling to automate some of the things around boards' documentation, in particular the generation of the toctree?

Reason I'm thinking this is that here you have GigaDevice spelled Gigadevice (lowercase d), and the boards' vendor is set as "GigaDevice Semiconductor". Looks like the kind of inconsistencies that, while certainly not the end of the world, can easily spread to many places.

If board.yml starts adopting the vendor prefix, a first step could be that we automatically add entries to substititions.txt so that something like |vendor-gd| gets replaced by the associated entry in vendor-prefixes.txt

[gmarull]

@kartben It would be nice to implement a new extension to display an interactive list of boards, where you can filter by vendor, soc, etc. It should now be easier with the new board.yml file. Regarding vendor, I think board.yml should contain a vendor: $prefix, and use a database (like we do for DT), cc: @tejlmand

[tejlmand]

I think board.yml should contain a vendor: $prefix, and use a database (like we do for DT), cc: @tejlmand

Not against the idea, but we need to also remember that it should be easy for oot users to just create their own board.
Of course such users can provide a custom vendor-prefixes.txt file, but then it starts to require a bit more integration in multiple places.

I think we should have an enhancement issue, and then link that issue in here: #51831

[gmarull]

for now: using text found in vendor-prefixes, so at least we're consistent everywhere.

[tejlmand]

latest changes also looks good 👍