Merge branch 'master' into feature/usbtmc_vendor-specific

Author: HiFiPhile

.circleci/config.yml

@@ -19,13 +19,12 @@ jobs:
             echo "MATRIX_JSON=$MATRIX_JSON"
 
             BUILDSYSTEM_TOOLCHAIN=(
+              "cmake aarch64-gcc"
               "cmake arm-clang"
+              "cmake arm-gcc"
               "cmake esp-idf"
-              "make aarch64-gcc"
-              "make arm-gcc"
-              "make msp430-gcc"
-              "make riscv-gcc"
-              "make rx-gcc"
+              "cmake msp430-gcc"
+              "cmake riscv-gcc"
             )
 
             # only build IAR if not forked PR, since IAR token is not shared
@@ -67,7 +66,7 @@ jobs:
               FAMILY_LARGE=$(jq -n --argjson family "$FAMILY" --argjson resource "$RESOURCE_LARGE" '$family | map(select(IN($resource[])))')
               FAMILY=$(jq -n --argjson family "$FAMILY" --argjson resource "$RESOURCE_LARGE" '$family | map(select(IN($resource[]) | not))')
 
-              if [[ $toolchain == esp-idf ]]; then
+              if [[ $toolchain == esp-idf || $toolchain == arm-iar ]]; then
                 gen_build_entry "$build_system" "$toolchain" "$FAMILY" "large"
               else
                 gen_build_entry "$build_system" "$toolchain" "$FAMILY" "medium+"

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -22,10 +22,17 @@ body:
     validations:
       required: true
 
+  - type: input
+    attributes:
+      label: Commit SHA
+      placeholder: e.g 3a042b37da28d0ba1e5593eb1068ca5645d77b56 or version bundled by esp-idf or pico-sdk
+    validations:
+      required: true
+
   - type: input
     attributes:
       label: Board
-      placeholder: e.g Feather nRF52840 Express
+      placeholder: e.g Adafruit Feather nRF52840 Express
     validations:
       required: true
 

.github/actions/setup_toolchain/action.yml

@@ -17,7 +17,7 @@ runs:
       if: inputs.toolchain == 'arm-gcc'
       uses: carlosperate/arm-none-eabi-gcc-action@v1
       with:
-        release: '13.2.Rel1'
+        release: '14.2.Rel1'
 
     - name: Pull ESP-IDF docker
       if: inputs.toolchain == 'esp-idf'

.github/actions/setup_toolchain/toolchain.json

@@ -1,7 +1,7 @@
 {
   "aarch64-gcc": "https://developer.arm.com/-/media/Files/downloads/gnu-a/10.3-2021.07/binrel/gcc-arm-10.3-2021.07-x86_64-aarch64-none-elf.tar.xz",
   "arm-clang": "https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases/download/release-19.1.1/LLVM-ET-Arm-19.1.1-Linux-x86_64.tar.xz",
-  "arm-gcc": "https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/download/v13.2.1-1.1/xpack-arm-none-eabi-gcc-13.2.1-1.1-linux-x64.tar.gz",
+  "arm-gcc": "https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/download/v14.2.1-1.1/xpack-arm-none-eabi-gcc-14.2.1-1.1-linux-x64.tar.gz",
   "msp430-gcc": "http://software-dl.ti.com/msp430/msp430_public_sw/mcu/msp430/MSPGCC/9_2_0_0/export/msp430-gcc-9.2.0.50_linux64.tar.bz2",
   "riscv-gcc": "https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/download/v13.2.0-2/xpack-riscv-none-elf-gcc-13.2.0-2-linux-x64.tar.gz",
   "rx-gcc": "https://github.com/hathach/rx_device/releases/download/0.0.1/gcc-8.3.0.202411-GNURX-ELF.run",

.github/workflows/build.yml

@@ -8,8 +8,8 @@ on:
       - 'examples/**'
       - 'lib/**'
       - 'hw/**'
-      - 'tools/get_deps.py'
       - 'tools/build.py'
+      - 'tools/get_deps.py'
       - '.github/actions/**'
       - '.github/workflows/build.yml'
       - '.github/workflows/build_util.yml'
@@ -21,8 +21,9 @@ on:
       - 'examples/**'
       - 'lib/**'
       - 'hw/**'
-      - 'tools/get_deps.py'
+      - 'test/hil/**'
       - 'tools/build.py'
+      - 'tools/get_deps.py'
       - '.github/actions/**'
       - '.github/workflows/build.yml'
       - '.github/workflows/build_util.yml'
@@ -31,45 +32,57 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  HIL_JSON: test/hil/tinyusb.json
+
 jobs:
   set-matrix:
     runs-on: ubuntu-latest
     outputs:
       json: ${{ steps.set-matrix-json.outputs.matrix }}
+      hil_json: ${{ steps.set-matrix-json.outputs.hil_matrix }}
     steps:
       - name: Checkout TinyUSB
         uses: actions/checkout@v4
 
       - name: Generate matrix json
         id: set-matrix-json
         run: |
+          # build matrix
           MATRIX_JSON=$(python .github/workflows/ci_set_matrix.py)
           echo "matrix=$MATRIX_JSON"
           echo "matrix=$MATRIX_JSON" >> $GITHUB_OUTPUT
+          # hil matrix
+          HIL_MATRIX_JSON=$(python test/hil/hil_ci_set_matrix.py ${{ env.HIL_JSON }})
+          echo "hil_matrix=$HIL_MATRIX_JSON"
+          echo "hil_matrix=$HIL_MATRIX_JSON" >> $GITHUB_OUTPUT
 
   # ---------------------------------------
-  # Build CMake
+  # Build CMake: only build on push with one-per-family.
+  # Full built is done by CircleCI in PR
   # ---------------------------------------
   cmake:
+    if: github.event_name == 'push'
     needs: set-matrix
     uses: ./.github/workflows/build_util.yml
     strategy:
       fail-fast: false
       matrix:
         toolchain:
-          # - 'arm-clang' is built by circle-ci in PR
           - 'aarch64-gcc'
+          #- 'arm-clang'
           - 'arm-gcc'
+          - 'esp-idf'
           - 'msp430-gcc'
           - 'riscv-gcc'
     with:
       build-system: 'cmake'
       toolchain: ${{ matrix.toolchain }}
       build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)[matrix.toolchain]) }}
-      one-per-family: ${{ github.event_name == 'push' }}
+      one-per-family: true
 
   # ---------------------------------------
-  # Build Make (built by circle-ci in PR, only build on push here)
+  # Build Make: only build on push with one-per-family
   # ---------------------------------------
   make:
     if: github.event_name == 'push'
@@ -79,36 +92,18 @@ jobs:
       fail-fast: false
       matrix:
         toolchain:
-          # 'arm-clang'
-          - 'arm-gcc'
           - 'aarch64-gcc'
+          #- 'arm-clang'
+          - 'arm-gcc'
           - 'msp430-gcc'
           - 'riscv-gcc'
           - 'rx-gcc'
-          - 'esp-idf'
     with:
       build-system: 'make'
       toolchain: ${{ matrix.toolchain }}
       build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)[matrix.toolchain]) }}
       one-per-family: true
 
-  # ---------------------------------------
-  # Build Make on Windows/MacOS
-  # ---------------------------------------
-  make-os:
-    if: github.event_name == 'pull_request'
-    uses: ./.github/workflows/build_util.yml
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [windows-latest, macos-latest]
-    with:
-      os: ${{ matrix.os }}
-      build-system: 'make'
-      toolchain: 'arm-gcc'
-      build-args: '["stm32h7"]'
-      one-per-family: true
-
   # ---------------------------------------
   # Build IAR
   # Since IAR Token secret is not passed to forked PR, only build non-forked PR with make.
@@ -131,6 +126,23 @@ jobs:
       build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)['arm-iar']) }}
       one-per-family: true
 
+  # ---------------------------------------
+  # Build Make on Windows/MacOS
+  # ---------------------------------------
+  make-os:
+    if: github.event_name == 'pull_request'
+    uses: ./.github/workflows/build_util.yml
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest]
+    with:
+      os: ${{ matrix.os }}
+      build-system: 'make'
+      toolchain: 'arm-gcc'
+      build-args: '["stm32h7"]'
+      one-per-family: true
+
   # ---------------------------------------
   # Zephyr
   # ---------------------------------------
@@ -151,3 +163,113 @@ jobs:
         run: |
           west build -b pca10056 -d examples/device/cdc_msc/build examples/device/cdc_msc -- -DRTOS=zephyr
           west build -b pca10056 -d examples/device/msc_dual_lun/build examples/device/msc_dual_lun -- -DRTOS=zephyr
+
+  # ---------------------------------------
+  # Hardware in the loop (HIL)
+  # Run on PR only (hil-tinyusb), hil-hfp only run on non-forked PR
+  # ---------------------------------------
+  hil-build:
+    if: |
+      github.repository_owner == 'hathach' &&
+      (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
+    needs: set-matrix
+    uses: ./.github/workflows/build_util.yml
+    strategy:
+      fail-fast: false
+      matrix:
+        toolchain:
+          - 'arm-gcc'
+          - 'esp-idf'
+    with:
+      build-system: 'cmake'
+      toolchain: ${{ matrix.toolchain }}
+      build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.hil_json)[matrix.toolchain]) }}
+      one-per-family: true
+      upload-artifacts: true
+
+  # ---------------------------------------
+  # Hardware in the loop (HIL)
+  # self-hosted on local VM, for attached hardware checkout HIL_JSON
+  # ---------------------------------------
+  hil-tinyusb:
+    if: |
+      github.repository_owner == 'hathach' &&
+      (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
+    needs: hil-build
+    runs-on: [self-hosted, X64, hathach, hardware-in-the-loop]
+    steps:
+      - name: Clean workspace
+        if: github.run_attempt == '1'
+        run: |
+          echo "Cleaning up for the first run"
+          rm -rf "${{ github.workspace }}"
+          mkdir -p "${{ github.workspace }}"
+
+      - name: Checkout TinyUSB
+        if: github.run_attempt == '1'
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: test/hil
+
+      - name: Download Artifacts
+        if: github.run_attempt == '1'
+        uses: actions/download-artifact@v4
+        with:
+          path: cmake-build
+          merge-multiple: true
+
+      - name: Test on actual hardware
+        run: |
+          ls cmake-build/
+
+          # Skip boards that passed with previous run, file is generated by hil_test.py
+          SKIP_BOARDS=""
+          if [ -f ${{ env.HIL_JSON }}.skip ]; then
+            SKIP_BOARDS=$(cat "${HIL_JSON}.skip")
+          fi
+          echo "SKIP_BOARDS=$SKIP_BOARDS"
+
+          python3 test/hil/hil_test.py ${{ env.HIL_JSON }} $SKIP_BOARDS
+
+  # ---------------------------------------
+  # Hardware in the loop (HIL)
+  # self-hosted by HFP, build with IAR toolchain, for attached hardware checkout test/hil/hfp.json
+  # Since IAR Token secret is not passed to forked PR, only build non-forked PR
+  # ---------------------------------------
+  hil-hfp:
+    if: |
+      github.repository_owner == 'hathach' &&
+      github.event.pull_request.head.repo.fork == false &&
+      (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
+    runs-on: [self-hosted, Linux, X64, hifiphile]
+    env:
+      IAR_LMS_BEARER_TOKEN: ${{ secrets.IAR_LMS_BEARER_TOKEN }}
+    steps:
+      - name: Clean workspace
+        run: |
+          echo "Cleaning up previous run"
+          rm -rf "${{ github.workspace }}"3
+          mkdir -p "${{ github.workspace }}"
+
+      - name: Toolchain version
+        run: |
+          iccarm --version
+
+      - name: Checkout TinyUSB
+        uses: actions/checkout@v4
+
+      - name: Get build boards
+        run: |
+          MATRIX_JSON=$(python test/hil/hil_ci_set_matrix.py test/hil/hfp.json)
+          BUILD_ARGS=$(echo $MATRIX_JSON | jq -r '.["arm-gcc"] | join(" ")')
+          echo "BUILD_ARGS=$BUILD_ARGS"
+          echo "BUILD_ARGS=$BUILD_ARGS" >> $GITHUB_ENV
+
+      - name: Get Dependencies
+        run: python3 tools/get_deps.py $BUILD_ARGS
+
+      - name: Build
+        run: python3 tools/build.py -j 4 --toolchain iar $BUILD_ARGS
+
+      - name: Test on actual hardware (hardware in the loop)
+        run: python3 test/hil/hil_test.py hfp.json

.github/workflows/ci_set_matrix.py

@@ -24,7 +24,7 @@
     "lpc11 lpc13 lpc15": ["arm-gcc", "arm-clang"],
     "lpc17 lpc18 lpc40 lpc43": ["arm-gcc", "arm-clang"],
     "lpc51 lpc54 lpc55": ["arm-gcc", "arm-clang"],
-    "max32650 max32666 max32690 max78002": ["arm-gcc"],
+    "maxim": ["arm-gcc"],
     "mcx": ["arm-gcc"],
     "mm32": ["arm-gcc"],
     "msp430": ["msp430-gcc"],
@@ -40,8 +40,9 @@
     "stm32f4": ["arm-gcc", "arm-clang", "arm-iar"],
     "stm32f7": ["arm-gcc", "arm-clang", "arm-iar"],
     "stm32g0 stm32g4 stm32h5": ["arm-gcc", "arm-clang", "arm-iar"],
-    "stm32h7": ["arm-gcc", "arm-clang", "arm-iar"],
+    "stm32h7 stm32h7rs": ["arm-gcc", "arm-clang", "arm-iar"],
     "stm32l0 stm32l4": ["arm-gcc", "arm-clang", "arm-iar"],
+    "stm32n6": ["arm-gcc"],
     "stm32u5 stm32wb": ["arm-gcc", "arm-clang", "arm-iar"],
     "xmc4000": ["arm-gcc"],
     "-bespressif_s2_devkitc": ["esp-idf"],

.github/workflows/codeql.yml

@@ -66,7 +66,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -93,7 +93,7 @@ jobs:
         ./.github/workflows/codeql-buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"
         upload: false
@@ -124,12 +124,12 @@ jobs:
         output: ${{ steps.step1.outputs.sarif-output }}/cpp.sarif
 
     - name: Upload SARIF
-      uses: github/codeql-action/upload-sarif@v2
+      uses: github/codeql-action/upload-sarif@v3
       with:
         sarif_file: ${{ steps.step1.outputs.sarif-output }}
         category: "/language:${{matrix.language}}"
 
-    - name: Archive CodeQL results
+    - name: Upload CodeQL results as an artifact
       uses: actions/upload-artifact@v4
       with:
         name: codeql-results