Merge branch 'master' into HIL-test

.gitattributes

@@ -0,0 +1,17 @@
+# Configuration to handle line endings for working with Windows and Unix
+# Reference: 
+# https://help.github.com/articles/dealing-with-line-endings/
+# https://git-scm.com/docs/gitattributes#_checking_out_and_checking_in
+
+* text=auto
+
+*.c text
+*.cpp text
+*.h text
+*.hpp text
+*.ino text
+*.py text
+
+
+*.sh text eol=lf
+*.bat text eol=crlf

.github/workflows/hil-unity-checks.yml

@@ -7,6 +7,9 @@ on:
 env:
   TEST_VERSION: 1.0.0
 
+permissions:
+  contents: write
+
 # This template runes multiple workflows
 jobs:
 
@@ -27,6 +30,9 @@ jobs:
       # checkout the latest github action code
       - name: Checkout actions
         uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.UNITY_TOKEN }}
+          submodules: recursive
 
       # checkout the latest arduino-cli compiler
       - name: Setup Arduino CLI
@@ -51,7 +57,7 @@ jobs:
           ./py_checkusb.py --switch repo --namelist $REPO --onoff on
 
           # set the hil-unity-checks
-          hil=$(./py_checkusb.py --readyaml $GITHUB_WORKSPACE/tests/unity/hil-unity-checklist.yaml --json)
+          hil=$(./py_checkusb.py --readyaml $GITHUB_WORKSPACE/tests/hil-unity-checklist.yaml --json)
           echo "hil=${hil}" >> $GITHUB_OUTPUT
 
           # fetch unity libraries
@@ -97,6 +103,9 @@ jobs:
       # checkout the latest github action code
       - name: Checkout actions
         uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.UNITY_TOKEN }}
+          submodules: recursive
 
       # setup environment
       - name: Environment
@@ -168,11 +177,11 @@ jobs:
               # loop over all tests for one example and compile7flash the devices
               readarray -t TESTS < <(echo $lib | jq ".\"${LIB}\".\"${EXAMPLE}\"[]" -r --compact-output)
               for ((idx=0; idx<${#TESTS[@]}; ++idx)); do
-                cd $GITHUB_WORKSPACE/tests/unity/
+                cd $GITHUB_WORKSPACE/tests/arduino-core-tests/
                 echo "=============================================================================================================="
-                echo "Run on index $idx for TEST: ${TESTS[idx]} under EXAMPLE: ${EXAMPLE} and LIB: ${LIB}"
+                echo "Run on index $idx for TEST: ${TESTS[idx]} under EXAMPLE: ${EXAMPLE} and LIB: ${LIB} on port: ${PORTS[idx]}"
                 echo "=============================================================================================================="
-                make FQBN=${{ env.fqbn }} PORT=${PORTS[idx]} UNITY_PATH=/opt/runner_support/Unity_github ${TESTS[idx]}
+                make FQBN=${{ env.fqbn }} PORT=${PORTS[idx]} UNITY_PATH=/opt/Unity ${TESTS[idx]}
                 mkdir -p ~/artefact/${LIB}/${EXAMPLE}/${TESTS[idx]}/
                 mv ./build/build/* ~/artefact/${LIB}/${EXAMPLE}/${TESTS[idx]}/.
                 echo "=============================================================================================================="
@@ -186,8 +195,8 @@ jobs:
                         /opt/runner_support/py_console.py \
                           --port ${PORTS[idx]} \
                           --baud 115200 \
-                          --runtime 50 \
                           --report ~/artefact/${LIB}/${EXAMPLE}/${TESTS[idx]}/${{ env.device }}/report.json
+                
                 echo "=============================================================================================================="
               done # end of TEST loop monitor
 

.gitignore

@@ -1,5 +1,7 @@
+# vscode
 .history
 .vscode
+.editorconfig
 
 # build folder
 pkg_build
@@ -9,11 +11,12 @@ build
 **/__pycache__/
 venv/
 
-# code-check reports
+# code-check standards and reports
+misra.txt
 clang-tidy-report.txt
 
 scan-build-reports/
 
 cppcheck_reports/
 cppcheck.checkers
-err.xml
+err.xml

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "arduino-core-tests"]
+	path = tests/arduino-core-tests
+	url = https://github.com/Infineon/arduino-core-tests.git

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socioeconomic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -1,47 +1,56 @@
-# Contributing to XMC for Arduino
-First important point: **All Contributions** are welcomed :open_hands:.
-
-Please contribute and raise issues via the [github repository](https://github.com/Infineon/XMC-for-Arduino/tree/master)
-
-### Overview for Contributors
-
-- Start your contribution by creating a [fork](https://github.com/Infineon/XMC-for-Arduino/fork) of this repository
-- It's recommended to create a separate branch for your contribution in your fork
-- Once your contribution is ready & tested, please create a [Pull Request](https://github.com/Infineon/XMC-for-Arduino/compare) to the master branch
-- Once we merged your changes to the master branch, they are automatically included in the next release
-
-### Testing in Arduino IDE (on Windows)
-Clone the repository in Arduino folder:
-- Open Arduino and install any version of this project as described [here](https://xmc-arduino.readthedocs.io/en/latest/installation-instructions.html).
-- Open the installation location in your Arduino program folder, e.g.
-`C:\Users\<username>\AppData\Local\Arduino15\packages\Infineon\hardware\xmc`
-- Open git bash, type command:
-`git clone <your-xmc-for-arduino-fork> <version>`
-
-This allows quick testing of local changes during development.
-
-[!TIP] 
-If you encounter strange behavior with Arduino IDE during development, try cleaning up the cache:
-* Windows: `C:\User\"username"\AppData\Roaming\arduino-ide`
-* Linux: `~/.config/arduino-ide`
-* macOS: `~/Library/Application Support/arduino-ide/`
-
-### Automated Build Checks
-
-Currently a Github workflow is used for automatic compilation checking and releasing. Workflows are defined [here](https://github.com/Infineon/XMC-for-Arduino/tree/master/.github/workflows).
-Before opening a Pull Request for your contribution, please add a git tag in the format `Vx.y.z` (e.g. V3.3.0) to trigger the release process in your fork and pass the compilation tests.
-
-### Creating and Maintaining Third Party Libraries
-#### Basics
-The Arduino IDE allows for external libraries to be added to support specific devices and functions which are not part of the core setup. For details on creating libraries see the 
-[Arduino library specifications](https://arduino.github.io/arduino-cli/library-specification/). If you add additional libraries to this project, make sure to [document them](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html) accordingly.
-
-#### XMC-for-Arduino Configuration
-To ensure that a library specific to one architecture or board type is only compiled when a supporting board is set up, this specification includes a setting for *architecture* in the *library.properties* file.
-
-When creating or maintaining third party or external libraries for XMC-for-Arduino please use this setting:
-~~~
-architecture=xmc
-~~~
-
-If your library also supports other boards and architectures, add those in as well.
+# Contributing to XMC for Arduino
+First important point: **All Contributions** are welcomed :open_hands:.
+
+Please contribute and raise issues via the [github repository](https://github.com/Infineon/XMC-for-Arduino/tree/master)
+
+## Overview for Contributors
+
+- Start your contribution by creating a [fork](https://github.com/Infineon/XMC-for-Arduino/fork) of this repository
+- It's recommended to create a separate branch for your contribution in your fork
+- Once your contribution is ready & tested, please create a [Pull Request](https://github.com/Infineon/XMC-for-Arduino/compare) to the master branch
+- Once we merged your changes to the master branch, they are automatically included in the next release
+
+## Install the BSP under development (on Windows)
+Clone the repository in Arduino folder:
+- Open Arduino and install any version of this project as described [here](https://xmc-arduino.readthedocs.io/en/latest/installation-instructions.html).
+- Open the installation location in your Arduino program folder, e.g.
+`C:\Users\<username>\AppData\Local\Arduino15\packages\Infineon\hardware\xmc`
+- Open git bash, type command:
+`git clone <your-xmc-for-arduino-fork> <version>`
+
+This allows quick testing of local changes during development.
+
+[!TIP] 
+If you encounter strange behavior with Arduino IDE during development, try cleaning up the cache:
+* Windows: `C:\User\"username"\AppData\Roaming\arduino-ide`
+* Linux: `~/.config/arduino-ide`
+* macOS: `~/Library/Application Support/arduino-ide/`
+
+## Automated Build Checks
+
+Currently a Github workflow is used for automatic compilation checking and releasing. Workflows are defined [here](https://github.com/Infineon/XMC-for-Arduino/tree/master/.github/workflows).
+Before opening a Pull Request for your contribution, please add a git tag in the format `Vx.y.z` (e.g. V3.3.0) to trigger the release process in your fork and pass the compilation tests.
+
+## Creating and Maintaining Third Party Libraries
+### Basics
+The Arduino IDE allows for external libraries to be added to support specific devices and functions which are not part of the core setup. For details on creating libraries see the 
+[Arduino library specifications](https://arduino.github.io/arduino-cli/library-specification/). If you add additional libraries to this project, make sure to [document them](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html) accordingly.
+
+### XMC-for-Arduino Configuration
+To ensure that a library specific to one architecture or board type is only compiled when a supporting board is set up, this specification includes a setting for *architecture* in the *library.properties* file.
+
+When creating or maintaining third party or external libraries for XMC-for-Arduino please use this setting:
+~~~
+architecture=xmc
+~~~
+
+If your library also supports other boards and architectures, add those in as well.
+
+## Validation test
+To test the XMC4arduino, we used unity to test some of the features of the arduino core & builtin library. 
+
+Tests are located in tests/arduino-core-tests and included as submodule in this project. Run  `git submodule update --init --recursive` to update them.  If you are nor familiar with submodules, check out: https://git-scm.com/book/en/v2/Git-Tools-Submodules 
+
+## Code checks (WIP)
+Refer to libraries\CAN\Makefile.codecheck
+* Regarding formatting, we currently use [pre-commit](https://pre-commit.com/) to automatically run clang-formatting to format all c/c++ code. Please install this python package, and follow the quick start (the pre-commit configuration file is already there). You should be able to format your code automatically on git commit!