Add TI Arm Clang Compiler Support to Core Tests (#277)

Builds on previous work in CMSIS-Toolbox to add TI Arm Clang Compiler
support to CMSIS under designator `CLANG_TI`.

- Adds `Clang_TI` option to Core Unit Tests scripts.
- Adds new Cortex-R device selections to Core Unit Tests scripts.
- Updates documentation to include new compiler and devices.
- Fixes link issue with `Clang Compiler 20.1.0` which pointed to 404
website. Moved link from LLVM Embedded Toolchain to new Arm Toolchain
for Embedded repo.

Note: Cortex-R support is dependent on pull request
[#45](#45) and future header
updates.

Author: smmasongt

.github/workflows/core.yml

@@ -20,6 +20,10 @@ jobs:
 
     env:
       ARM_UBL_ACTIVATION_CODE: ${{ secrets.ARM_UBL_ACTIVATION_CODE }}
+      CLANG_TI_VERSION: "5.1.0.LTS"
+      CLANG_TI_TC_SUFFIX: "5_1_0"
+      CLANG_TI_INSTALL_PATH: "/home/runner/"
+      CLANG_TI_SHA256: "c758668b78c080be5ec75393cdd09d077742fd1183aa0c181318a0119d58c4d0"
 
     steps:
       - uses: actions/checkout@v6
@@ -52,6 +56,30 @@ jobs:
 
       - uses: ammaraskar/gcc-problem-matcher@master
 
+      - name: Set TI ARM CLANG Environment Variables and Path
+        run: |
+          echo "CLANG_TI_PATH=${{ env.CLANG_TI_INSTALL_PATH }}ti-cgt-armllvm_${{ env.CLANG_TI_VERSION }}" >> $GITHUB_ENV
+          echo "CLANG_TI_TOOLCHAIN_${{ env.CLANG_TI_TC_SUFFIX }}=${{ env.CLANG_TI_INSTALL_PATH }}ti-cgt-armllvm_${{ env.CLANG_TI_VERSION }}/bin" >> $GITHUB_ENV
+
+      - name: Cache TI ARM CLANG
+        id: cache-ti-arm-clang
+        uses: actions/cache@v5
+        with:
+          path: ${{ env.CLANG_TI_PATH }}
+          key: ${{ runner.os }}-ti-arm-clang-${{ env.CLANG_TI_VERSION }}
+
+      - name: Download and Verify TI ARM CLANG Installer
+        working-directory: /home/runner
+        if: steps.cache-ti-arm-clang.outputs.cache-hit != 'true'
+        run: |
+          FILE="ti_cgt_armllvm_${{ env.CLANG_TI_VERSION }}_linux-x64_installer.bin"
+          URL="https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-ayxs93eZNN/${{ env.CLANG_TI_VERSION }}/${FILE}"
+    
+          curl -L "$URL" -o "$FILE"
+          echo "${{ env.CLANG_TI_SHA256 }}  $FILE" | sha256sum --check
+          chmod +x "$FILE"
+          ./"$FILE" --mode unattended --prefix "${{ env.CLANG_TI_INSTALL_PATH }}"
+
       - name: Run LIT
         working-directory: ./CMSIS/Core/Test
         run: |

CMSIS/Core/Test/README.md

@@ -25,6 +25,7 @@ Currently, the following build configurations are provided:
    - Arm Compiler 6 (AC6)
    - GNU Compiler (GCC)
    - LLVM/Clang (Clang)
+   - TI Arm Clang (Clang_TI) (CM0/0+/3/4/33, CR4/5/52)
 2. Devices
    - Cortex-M0
    - Cortex-M0+
@@ -63,6 +64,18 @@ Currently, the following build configurations are provided:
    - Cortex-A9
      - w/o NEON extensions
      - w NEON extensions
+   - Cortex-A53
+     - w/o NEON extensions
+     - w NEON extensions
+   - Cortex-R4
+     - w/o FPU
+     - with DP FPU
+   - Cortex-R5
+     - w/o FPU
+     - with DP FPU
+   - Cortex-R52
+     - w/o NEON extensions
+     - w NEON extensions
 3. Optimization Levels
    - none
    - balanced
@@ -75,7 +88,8 @@ The following tools are required to build and run the Core tests:
 
 - [Arm Compiler 6.23](https://artifacts.tools.arm.com/arm-compiler/6.23/32/)*
 - [GCC Compiler 14.2.1](https://artifacts.keil.arm.com/arm-none-eabi-gcc/14.2.1/)*
-- [Clang Compiler 20.1.0](https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases/tag/release-20.1.0)*
+- [Clang Compiler 20.1.0](https://github.com/arm/arm-toolchain/releases/tag/release-20.1.0-ATfE)*
+- [TI Arm Clang Compiler 5.1.0](https://www.ti.com/tool/download/ARM-CGT-CLANG)
 - [Python 3.9](https://www.python.org/downloads/)
 - [LLVM FileCheck](https://github.com/llvm/llvm-project/releases/)
   - Ubuntu package `llvm-<version>-tools`
@@ -95,6 +109,8 @@ Install the Python packages required by `build.py`:
  ./CMSIS/Core/Test $ pip install -r requirements.txt
 ```
 
+TI Arm Clang Compiler is not supported through vcpkg and must be manually installed.  After installation, configure the environment variable `CLANG_TI_TOOLCHAIN_<version>` with the format specified by [CMSIS-Toolbox Installation -> Compiler Registration](https://open-cmsis-pack.github.io/cmsis-toolbox/installation/). 
+
 ## Execute LIT tests
 
 To build and run the CoreValidation tests for one or more configurations use the following command line.

CMSIS/Core/Test/build.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 import logging
+import os
 
 from datetime import datetime
 from enum import Enum
@@ -39,27 +40,29 @@ class DeviceAxis(Enum):
     CM85S = ('Cortex-M85S', 'CM85S')
     CM85NS = ('Cortex-M85NS', 'CM85NS')
     CA5 = ('Cortex-A5', 'CA5')
-    CA7 = ('Cortex-A7', 'CA7')
-    CA9 = ('Cortex-A9', 'CA9')
     CA5NEON = ('Cortex-A5neon', 'CA5neon')
+    CA7 = ('Cortex-A7', 'CA7')
     CA7NEON = ('Cortex-A7neon', 'CA7neon')
+    CA9 = ('Cortex-A9', 'CA9')
     CA9NEON = ('Cortex-A9neon', 'CA9neon')
-    CA35      = ('Cortex-A35',      'CA35')
-    CA35NEON  = ('Cortex-A35neon',  'CA35')
-    CA53      = ('Cortex-A53',      'CA53')
-    CA53NEON  = ('Cortex-A53neon',  'CA53')
-    CA55      = ('Cortex-A55',      'CA55')
-    CA55NEON  = ('Cortex-A55neon',  'CA55')
-    CR4       = ('Cortex-R4',       'CR4')
-    CR4F      = ('Cortex-R4F',      'CR4F')
-    CR5       = ('Cortex-R5',       'CR5')
-    CR5F      = ('Cortex-R5F',      'CR5F')
-    CR7       = ('Cortex-R7',       'CR7')
-    CR7F      = ('Cortex-R7F',      'CR7F')
-    CR8       = ('Cortex-R8',       'CR8')
-    CR8F      = ('Cortex-R8F',      'CR8F')
-    CR52      = ('Cortex-R52',      'CR52')
-    CR52NEON  = ('Cortex-R52neon',  'CR52neon')
+    CA35 = ('Cortex-A35', 'CA35')
+    CA35NEON = ('Cortex-A35neon', 'CA35neon')
+    CA53 = ('Cortex-A53', 'CA53')
+    CA53NEON = ('Cortex-A53neon', 'CA53neon')
+    CA55 = ('Cortex-A55', 'CA55')
+    CA55NEON = ('Cortex-A55neon', 'CA55neon')
+    CA57 = ('Cortex-A57', 'CA57')
+    CA57NEON = ('Cortex-A57neon', 'CA57neon')
+    CR4 = ('Cortex-R4', 'CR4')
+    CR4DP = ('Cortex-R4DP', 'CR4DP')
+    CR5 = ('Cortex-R5', 'CR5')
+    CR5DP = ('Cortex-R5DP', 'CR5DP')
+    CR7 = ('Cortex-R7', 'CR7')
+    CR7DP = ('Cortex-R7DP', 'CR7DP')
+    CR8 = ('Cortex-R8', 'CR8')
+    CR8DP = ('Cortex-R8DP', 'CR8DP')
+    CR52 = ('Cortex-R52', 'CR52')
+    CR52NEON = ('Cortex-R52neon', 'CR52neon')
 
 
 @matrix_axis("compiler", "c", "Compiler(s) to be considered.")
@@ -68,6 +71,7 @@ class CompilerAxis(Enum):
     GCC = ('GCC')
     IAR = ('IAR')
     CLANG = ('Clang')
+    CLANG_TI = ('Clang_TI')
 
 
 @matrix_axis("optimize", "o", "Optimization level(s) to be considered.")
@@ -82,18 +86,19 @@ def timestamp():
     return datetime.now().strftime('%Y%m%d%H%M%S')
 
 
+def clean_output():
+    os.system("rm -f ./src/Output/*")
+
+
 @matrix_action
 def lit(config, results):
     """Run tests for the selected configurations using llvm's lit."""
+    clean_output()
     yield run_lit(config.compiler[0], config.device[1], config.optimize[0])
     results[0].test_report.write(f"lit-{config.compiler[0]}-{config.optimize[0]}-{config.device[1]}-{timestamp()}.xunit")
 
 
-def timestamp():
-    return datetime.now().strftime('%Y%m%d%H%M%S')
-
-
-@matrix_command(exit_code=[0, 1], test_report=FileReport(f"lit.xml") | JUnitReport())
+@matrix_command(exclusive=True, exit_code=[0, 1], test_report=FileReport(f"lit.xml") | JUnitReport())
 def run_lit(toolchain, device, optimize):
     return ["lit", "--xunit-xml-output", f"lit.xml", "-D", f"toolchain={toolchain}", "-D", f"device={device}", "-D", f"optimize={optimize}", "src" ]
 
@@ -110,5 +115,25 @@ def filter_gcc_cm52(config):
     return device and compiler
 
 
+@matrix_filter
+def filter_clang_ti_supported_devices(config):
+    device = not config.device.match('CM0')
+    device &= not config.device.match('CM0plus')
+    device &= not config.device.match('CM3')
+    device &= not config.device.match('CM4')
+    device &= not config.device.match('CM4FP')
+    device &= not config.device.match('CM33')
+    device &= not config.device.match('CM33S')
+    device &= not config.device.match('CM33NS')
+    device &= not config.device.match('CR4')
+    device &= not config.device.match('CR4DP')
+    device &= not config.device.match('CR5')
+    device &= not config.device.match('CR5DP')
+    device &= not config.device.match('CR52')
+    device &= not config.device.match('CR52neon')
+    compiler = config.compiler.match('Clang_TI')
+    return device and compiler
+
+
 if __name__ == "__main__":
     main()