4.0.0 metafiles naming conventions boardname #360

LinjingZhang · 2025-07-08T12:49:09Z

By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---

CONTRIBUTING.md also tells you what to expect in the PR process.

Description
update metafiles naming according the convention: https://confluencewikiprod.intra.infineon.com/spaces/ARDUINO/pages/1951456037/Metafiles+variables+naming+conventions
This PR also change all the name of boards.

Related Issue
https://jirard.intra.infineon.com/browse/DESMAKERS-4121

Context

The issue of 3rd party library macro is resolved by adding old vairiants macro.

jaenrig-ifx

And the ci seems to be compile straight away? :)

docs/builtin-libraries.rst

jaenrig-ifx · 2025-07-08T13:13:21Z

docs/hw-platforms.rst

@@ -47,13 +47,13 @@ The following XMC microcontroller boards are supported by XMC for Arduino:
 KIT_XMC11_BOOT_001
 ------------------

-* Name in Arduino IDE: ``XMC1100 Boot Kit``
+* Legacy name: ``XMC1100 Boot Kit``


Why do we keep the legacy name?
The idea of renaming is to have unify and simplify to one name.
If the user get´s lost, maybe a look up table with legacy name and new name would be convenient? But then keep it in a section decouple from the main doc, so that we have a clean single naming approach across code and docs.

What do you mean by decouple? Separate pages of the name LUT?

If we would be already in 4.x for new users the legacy name is not relevant no?
Then I would maybe put in a different section.
But wait with any changes until we decide how to proceed with all these naming topics :)

docs/hw-platforms.rst

jaenrig-ifx · 2025-07-08T13:15:05Z

libraries/DMA/examples/DMA_UART/DMA_UART.ino

@@ -1,5 +1,5 @@
 /*
- * Simple DMA example for XMC4700 Relax Kit V1
+ * Simple DMA example for KIT_XMC47_RELAX_5V_AD_V1 V1


V1 not required? already in the board name?

There are these xmc relax kit products:

KIT_XMC47_RELAX_V1 : https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_v1/
KIT_XMC47_RELAX_LITE_V1 : https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_lite_v1/
KIT_XMC47_RELAX_5V_AD_V1: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/

If they are all supported by the same core variant... maybe that naming is too restrictive. And even the product website name is not the best but something like KIT_XMC47_RELAX?

KIT_XMC47_RELAX is taken

taken? is there a product named like that?

Maybe my reply was too short, what I meant was that I think you have a valid point therefore change all KIT_XMC47_RELAX_5V_AD_V1 to KIT_XMC47_RELAX

libraries/SPI/src/SPI.h

jaenrig-ifx · 2025-07-08T13:24:12Z

The missing thing would be to rename the pinout diagram boards name as well.

package/config.yml

LinjingZhang · 2025-07-08T15:06:45Z

And the ci seems to be compile straight away? :)

Yes, I also updated the arduino-devops.
But for v4.0.0 now we only compile for kit_xmc47. Yet unable to test other board

Copilot

Pull Request Overview

This PR renames board identifiers and updates metafile naming to follow the new convention across code, tests, documentation, and configuration.

Renamed all board macros (e.g., XMC1100_Boot_Kit → KIT_XMC11_BOOT_001) in tests and libraries
Updated documentation (.rst, README.md, Markdown) to reference new board names and package indexes
Modified build metadata (boards.txt, platform.txt, package_xmc_index.template.json, YAML files) to reflect new identifiers and added board_variant_old where needed

Reviewed Changes

Copilot reviewed 35 out of 45 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tests/manual/tonetest/tonetest.ino	Updated `#if defined` checks to new board macros
tests/manual/analogwritetest/analogwritetest.ino	Updated conditional macros for analogWrite across boards
tests/manual/Servotest/Servotest.ino	Renamed boards in comments and updated PWM pin listings
tests/manual/PWMtest/PWMtest.ino	Replaced boot‐kit macro in comments
tests/manual/PCLKTest/PCLKTest.ino	Updated comments and defines for new boot‐kit macro
tests/hil-unity-checklist.yaml	Lowercased and renamed test suite board keys
tests/Makefile.test	Updated `FQBN` values to new board package names
platform.txt	Added `board_variant_old` in compile recipes
package/package_xmc_index.template.json	Lowercased package name and updated board list
package/config.yml	Changed `index-name` to match new package index
libraries/Wire/src/Wire.cpp	Updated `#if defined` for renamed boards
libraries/SPI/src/SPI.h	Updated board macro in SD card slot comment
libraries/RTC/examples/*	Replaced board names in example headers and `#error` lines
libraries/OneWire/src/util/OneWireConf.h	Updated hardware‐mapping macros for renamed boards
libraries/LED/Readme.md	Updated board table to use new names
libraries/I2S/src/I2S.h/.cpp/README.md	Updated wiring docs and interrupt macros for new boards
libraries/DeviceControlXMC/examples/*	Replaced board names in example headers
libraries/DMA/examples/*	Replaced board names in example headers
libraries/CAN/README.md	Updated hardware setup section with new board names
extras/arduino-devops	Advanced submodule commit
docs/*.rst & README.md	Updated links, image references, and board descriptions
cores/xmc/*.c/.cpp/.h	Updated board macro checks and comments
ci-matrix-config.yml	Updated FQBN entries to new board package IDs
boards.txt	Completely replaced old board sections with new identifiers

Comments suppressed due to low confidence (3)

tests/manual/tonetest/tonetest.ino:77

The conditional still references XMC1300_Sense2GoL; to align with the new naming scheme, either rename that macro or introduce the corresponding KIT_ variant.

#elif defined( XMC1300_Sense2GoL )

tests/manual/analogwritetest/analogwritetest.ino:30

Inconsistent macro naming: XMC1300_Sense2GoL remains in the same check. Consider updating it to a KIT_ version or removing if obsolete.

#if defined ( KIT_XMC11_BOOT_001 ) || defined ( KIT_XMC1400_ARDUINO ) || defined ( XMC1300_Sense2GoL )

package/package_xmc_index.template.json:19

The help.online field is empty; please provide the correct documentation URL or remove the empty entry.

                        "online": ""

bargfred

I cannot really help a lot here.

LinjingZhang · 2025-07-10T13:42:10Z

I cannot really help a lot here.

haha maybe I want to ask you about this as it may affect changing names and paths inside some of the HIL processes, but it will make all the names uniform and clear. Do you think merge this is ok?

Signed-off-by: zhanglinjing <[email protected]>

LinjingZhang · 2025-07-11T13:30:59Z

The missing thing would be to rename the pinout diagram boards name as well.

@ederjc Can you provide the source file for the pinout diagram?

jaenrig-ifx · 2025-07-14T07:22:45Z

docs/hw-platforms.rst

@@ -34,8 +34,8 @@ The following XMC microcontroller boards are supported by XMC for Arduino:
     - :ref:`KIT_XMC_PLT2GO_XMC4400`
     - XMC4400
     - Arduino Uno, Shield2Go, mikroBUS
-   * - .. image:: img/KIT_XMC47_RELAX_5V_AD_V1.jpg
-     - :ref:`KIT_XMC47_RELAX_5V_AD_V1`
+   * - .. image:: img/KIT_XMC47_RELAX.jpg


Can we explicitly add in this table the available XMC4700 boards covered by KIT_XMC47_RELAX?

jaenrig-ifx

Nice :)

jaenrig-ifx

The workflows are still not running. Let´s fix that before merging.

jaenrig-ifx

Also we should update the pinout diagrams titles... 👯

LinjingZhang · 2025-07-14T15:33:12Z

The workflows are still not running. Let´s fix that before merging.

This is related to the compilation test issue on the other board.
Should I commit to this branch? This would be another ‘few lines’ of code changes 😃.

jaenrig-ifx · 2025-07-14T16:12:55Z

The workflows are still not running. Let´s fix that before merging.

This is related to the compilation test issue on the other board. Should I commit to this branch? This would be another ‘few lines’ of code changes 😃.

If it is easily doable, fine. If not, you can also keep only the boards which PASS, and create tasks for enabling/fixing the other ones?

LinjingZhang · 2025-07-15T12:19:20Z

The workflows are still not running. Let´s fix that before merging.

This is related to the compilation test issue on the other board. Should I commit to this branch? This would be another ‘few lines’ of code changes 😃.

If it is easily doable, fine. If not, you can also keep only the boards which PASS, and create tasks for enabling/fixing the other ones?

Branch for fixing the compilation error: 4.0.0-metafiles-naming-conventions-boardname-fix-compile
Compilation workflow: https://github.com/Infineon/XMC-for-Arduino/actions/runs/16289009924
This error log shows the problem that Dinesh mentioned last week in refinement meeting.
I revert the compile test enablement and will merge the name change so I could work on HIL. @jaenrig-ifx @ederjc is it ok?
Bug ticket added:https://jirard.intra.infineon.com/browse/DESMAKERS-4646

jaenrig-ifx

👍 nice !

ederjc

I am through, please have a look at the 17 comments.

Fix comments
Add overview of the available XMC4700 boards as Juan also requested.

cores/xmc/Arduino.h

cores/xmc/main.cpp

docs/hw-platforms.rst

libraries/CAN/README.md

tests/manual/PCLKTest/PCLKTest.ino

tests/manual/PWMtest/PWMtest.ino

tests/manual/Servotest/Servotest.ino

libraries/LED/Readme.md

docs/hw-platforms.rst

Signed-off-by: zhanglinjing <[email protected]>

LinjingZhang · 2025-07-16T13:57:35Z

I am through, please have a look at the 17 comments.

Fix comments

Add overview of the available XMC4700 boards as Juan also requested.

Please provide lists of boards name 😸

Signed-off-by: Eder Julian <[email protected]>

LinjingZhang changed the base branch from master to 4.0.0-pre-release July 8, 2025 12:49

LinjingZhang requested review from Copilot, bargfred, jaenrig-ifx and ederjc July 8, 2025 12:50

LinjingZhang marked this pull request as ready for review July 8, 2025 12:51

LinjingZhang mentioned this pull request Jul 8, 2025

Desmakers 4121 update metafiles naming conventions to harmonize with arduino psoc boardname Infineon/arduino-devops#19

Open

This comment was marked as outdated.

Sign in to view

LinjingZhang force-pushed the 4.0.0-metafiles-naming-conventions-boardname branch from 20c9188 to 03bf5f6 Compare July 8, 2025 13:16

jaenrig-ifx reviewed Jul 8, 2025

View reviewed changes

package/config.yml Outdated Show resolved Hide resolved

LinjingZhang requested review from Copilot and jaenrig-ifx July 8, 2025 15:08

Copilot AI reviewed Jul 8, 2025

View reviewed changes

bargfred approved these changes Jul 10, 2025

View reviewed changes

LinjingZhang added 12 commits July 11, 2025 14:57

variants/: Rename folder name of the boards.

11d393d

Signed-off-by: zhanglinjing <[email protected]>

cores/: Change the macro name of xmc boards.

1a262c3

Signed-off-by: zhanglinjing <[email protected]>

libraries/: Update all the boards name in builtin libraries.

ac42325

Signed-off-by: zhanglinjing <[email protected]>

package/: Update board names in index json.

2685eee

Signed-off-by: zhanglinjing <[email protected]>

tests/: Update name of boards.

c090f57

Signed-off-by: zhanglinjing <[email protected]>

libraries/SPI: Change KIT_XMC47_RELAX_5V_AD_V1 name in comment.

603ad0c

Signed-off-by: zhanglinjing <[email protected]>

boards.txt: Change boards name, keep old variant for backwards compat.

7657412

Signed-off-by: zhanglinjing <[email protected]>

ci-matrix-config.yml: Update boards name for compile config.

4046a8b

Signed-off-by: zhanglinjing <[email protected]>

platform.txt: Adding old boards macro for backwards compatibility.

a0c30fa

Signed-off-by: zhanglinjing <[email protected]>

docs: Update docs according name change of boards.

b11541b

Signed-off-by: zhanglinjing <[email protected]>

extras: Update arduino-devopsfor boards name change.

4fb9267

Signed-off-by: zhanglinjing <[email protected]>

boards.txt: Fix Typo.

5e4208a

Signed-off-by: zhanglinjing <[email protected]>

LinjingZhang added 4 commits July 11, 2025 14:57

ci-matrix-config.yml: Update name KIT_XMC47_RELAX.

c63cbad

Signed-off-by: zhanglinjing <[email protected]>

README.md: Update name KIT_XMC47_RELAX.

25caf74

Signed-off-by: zhanglinjing <[email protected]>

extras: Update arduino-devops for renaming.

753bd77

Signed-off-by: zhanglinjing <[email protected]>

extras: Update arduino-devops after review.

1dfa71c

Signed-off-by: zhanglinjing <[email protected]>

LinjingZhang force-pushed the 4.0.0-metafiles-naming-conventions-boardname branch from 24cc450 to 1dfa71c Compare July 11, 2025 12:58

docs/: Remove legacy name.

91ca1fc

Signed-off-by: zhanglinjing <[email protected]>

jaenrig-ifx reviewed Jul 14, 2025

View reviewed changes

jaenrig-ifx approved these changes Jul 14, 2025

View reviewed changes

jaenrig-ifx requested changes Jul 14, 2025

View reviewed changes

jaenrig-ifx reviewed Jul 14, 2025

View reviewed changes

LinjingZhang force-pushed the 4.0.0-metafiles-naming-conventions-boardname branch from 2f57160 to 91ca1fc Compare July 15, 2025 12:48

LinjingZhang requested a review from jaenrig-ifx July 15, 2025 12:49

jaenrig-ifx approved these changes Jul 15, 2025

View reviewed changes

ederjc requested changes Jul 16, 2025

View reviewed changes

LinjingZhang added 7 commits July 16, 2025 15:36

cores/xmc: Fix comments.

be28109

Signed-off-by: zhanglinjing <[email protected]>

docs: Improve doc.

5a5891e

Signed-off-by: zhanglinjing <[email protected]>

libraries/: Fix some naming and improve.

782363a

Signed-off-by: zhanglinjing <[email protected]>

tests/manual: Align number.

8f3d000

Signed-off-by: zhanglinjing <[email protected]>

tests: Minor change.

8602414

Signed-off-by: zhanglinjing <[email protected]>

libraries: Improve doc.

309f87a

Signed-off-by: zhanglinjing <[email protected]>

docs: Change board name for 2go sensor.

8bd2862

Signed-off-by: zhanglinjing <[email protected]>

LinjingZhang requested a review from ederjc July 16, 2025 13:58

ederjc approved these changes Jul 18, 2025

View reviewed changes

ederjc added 2 commits July 18, 2025 19:17

docs: Add all XMC4700 variants.

13980d5

Signed-off-by: Eder Julian <[email protected]>

docs: Incl product links in text.

929b395

Signed-off-by: Eder Julian <[email protected]>

4.0.0 metafiles naming conventions boardname #360

Are you sure you want to change the base?

4.0.0 metafiles naming conventions boardname #360

Conversation

LinjingZhang commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

jaenrig-ifx left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jaenrig-ifx commented Jul 8, 2025

Uh oh!

Uh oh!

LinjingZhang commented Jul 8, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

bargfred left a comment

Choose a reason for hiding this comment

Uh oh!

LinjingZhang commented Jul 10, 2025

Uh oh!

LinjingZhang commented Jul 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jaenrig-ifx left a comment

Choose a reason for hiding this comment

Uh oh!

jaenrig-ifx left a comment

Choose a reason for hiding this comment

Uh oh!

jaenrig-ifx left a comment

Choose a reason for hiding this comment

Uh oh!

LinjingZhang commented Jul 14, 2025

Uh oh!

jaenrig-ifx commented Jul 14, 2025

Uh oh!

LinjingZhang commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jaenrig-ifx left a comment

Choose a reason for hiding this comment

Uh oh!

ederjc left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LinjingZhang commented Jul 8, 2025 •

edited

Loading

LinjingZhang commented Jul 15, 2025 •

edited

Loading

ederjc left a comment •

edited

Loading

LinjingZhang commented Jul 16, 2025 •

edited by ederjc

Loading