ci: Add AHB controller tests to GitHub CI

kslominski-ant · kslominski-ant · commit becb289cb3a4 · 2026-08-04T16:47:44.000+02:00
Signed-off-by: Kacper Słomiński &lt;kslominski@antmicro.com&gt;
diff --git a/.github/workflows/tests-and-docs.yml b/.github/workflows/tests-and-docs.yml
@@ -3,17 +3,20 @@
 # I3C Core - Parallel Test and Documentation Workflow
 #
 # This workflow runs cocotb verification tests in parallel for AHB, AXI,
-# and AXI-Controller bus configurations, then builds and deploys documentation.
+# AXI-Controller, and AHB-controller bus configurations, then builds and
+# deploys documentation.
 #
 # Architecture:
 #   1. generate-timing-docs: Generates timing CSR markdown documents
 #   2. generate-matrix: Uses nox's JSON output to discover test sessions
 #   3. tests-ahb: Runs all AHB-tagged tests in parallel (one job per test)
-#   4. tests-axi: Runs all AXI-tagged tests in parallel (one job per test)
-#   5. tests-axi-controller-and-target: Runs all AXI-Controller tests in parallel
-#   6. tests-axi-controller-only: Runs all AXI-Controller only tests in parallel
-#   7. test-results: Aggregates results from all test jobs
-#   8. docs-build: Builds and deploys documentation (only after tests pass)
+#   4. tests-ahb-controller-and-target: Runs all AHB-Controller tests in parallel
+#   5. tests-ahb-controller-only: Runs all AHB-Controller only tests in parallel
+#   6. tests-axi: Runs all AXI-tagged tests in parallel (one job per test)
+#   7. tests-axi-controller-and-target: Runs all AXI-Controller tests in parallel
+#   8. tests-axi-controller-only: Runs all AXI-Controller only tests in parallel
+#   9. test-results: Aggregates results from all test jobs
+#   10. docs-build: Builds and deploys documentation (only after tests pass)
 #
 # Optional: Long-running tests (i3c_ahb_verify, i3c_axi_verify) can be split
 # into individual parametrized runs by enabling SPLIT_TESTS in generate-matrix.
@@ -89,6 +92,8 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       ahb-matrix: ${{ steps.gen.outputs.ahb_matrix }}
+      ahb-controller-and-target-matrix: ${{ steps.gen.outputs.ahb_controller_and_target_matrix }}
+      ahb-controller-only-matrix: ${{ steps.gen.outputs.ahb_controller_only_matrix }}
       axi-matrix: ${{ steps.gen.outputs.axi_matrix }}
       axi-controller-and-target-matrix: ${{ steps.gen.outputs.axi_controller_and_target_matrix }}
       axi-controller-only-matrix: ${{ steps.gen.outputs.axi_controller_only_matrix }}
@@ -148,6 +153,8 @@ jobs:
               sys.exit(1)
 
           ahb_tests = set()
+          ahb_controller_and_target_tests = set()
+          ahb_controller_only_tests = set()
           axi_tests = set()
           axi_controller_and_target_tests = set()
           axi_controller_only_tests = set()
@@ -172,7 +179,16 @@ jobs:
               has_target = "target" in tags
 
               if has_ahb:
-                  ahb_tests.add(session_id)
+                  if has_controller:
+                      # If it has a controller tag, it always runs in the combined job
+                      ahb_controller_and_target_tests.add(session_id)
+
+                      # Exclude tests that also require a target from the controller_only job
+                      if not has_target:
+                          ahb_controller_only_tests.add(session_id)
+                  else:
+                      # Standard AHB tests (target-only, no controller tag)
+                      ahb_tests.add(session_id)
               
               if has_axi:
                   if has_controller:
@@ -188,17 +204,23 @@ jobs:
 
           # Sort for consistent ordering
           ahb_tests = sorted(ahb_tests)
+          ahb_controller_and_target_tests = sorted(ahb_controller_and_target_tests)
+          ahb_controller_only_tests = sorted(ahb_controller_only_tests)
           axi_tests = sorted(axi_tests)
           axi_controller_and_target_tests = sorted(axi_controller_and_target_tests)
           axi_controller_only_tests = sorted(axi_controller_only_tests)
 
           print(f"Discovered {len(ahb_tests)} AHB tests")
+          print(f"Discovered {len(ahb_controller_and_target_tests)} AHB-Controller+Target tests")
+          print(f"Discovered {len(ahb_controller_only_tests)} AHB-Controller-Only tests")
           print(f"Discovered {len(axi_tests)} AXI (Target-Only) tests")
           print(f"Discovered {len(axi_controller_and_target_tests)} AXI-Controller+Target tests")
           print(f"Discovered {len(axi_controller_only_tests)} AXI-Controller-Only tests")
 
           with open(os.environ['GITHUB_OUTPUT'], 'a') as f:
               f.write(f"ahb_matrix={json.dumps(ahb_tests)}\n")
+              f.write(f"ahb_controller_and_target_matrix={json.dumps(ahb_controller_and_target_tests)}\n")
+              f.write(f"ahb_controller_only_matrix={json.dumps(ahb_controller_only_tests)}\n")
               f.write(f"axi_matrix={json.dumps(axi_tests)}\n")
               f.write(f"axi_controller_and_target_matrix={json.dumps(axi_controller_and_target_tests)}\n")
               f.write(f"axi_controller_only_matrix={json.dumps(axi_controller_only_tests)}\n")
@@ -309,6 +331,187 @@ jobs:
             verification/cocotb/**/*.xml
             verification/cocotb/**/*.log
 
+  # ===========================================================================
+  # Job: Run AHB-Controller and Target Tests (Parallel)
+  # ===========================================================================
+  tests-ahb-controller-and-target:
+    name: "AHB-Ctrl+Target: ${{ matrix.test }}"
+    needs: [generate-matrix, lint-testplans]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.generate-matrix.outputs.ahb-controller-and-target-matrix) }}
+    steps:
+      - name: Install system dependencies
+        run: |
+          sudo apt -qqy update
+          sudo apt -qqy --no-install-recommends install \
+            help2man libfl-dev make g++ git bison flex gperf \
+            libreadline-dev libbz2-dev autoconf
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Initialize submodules
+        run: git submodule update --init --recursive
+
+      - name: Cache Verilator installation
+        id: cache-verilator
+        uses: actions/cache@v4
+        with:
+          path: ~/verilator-install
+          key: verilator-install-${{ env.VERILATOR_VERSION }}-${{ runner.os }}
+
+      - name: Build Verilator (if not cached)
+        if: steps.cache-verilator.outputs.cache-hit != 'true'
+        run: |
+          git clone https://github.com/verilator/verilator -b ${{ env.VERILATOR_VERSION }}
+          cd verilator
+          autoconf
+          ./configure --prefix=$HOME/verilator-install
+          make -j$(nproc)
+          make install
+
+      - name: Add Verilator to PATH
+        run: |
+          echo "$HOME/verilator-install/bin" >> $GITHUB_PATH
+          echo "VERILATOR_ROOT=$HOME/verilator-install/share/verilator" >> $GITHUB_ENV
+
+      - name: Setup Python environment (pyenv + dependencies)
+        run: ./install.sh
+
+      - name: Configure RTL and run test
+        id: run-test
+        env:
+          TEST_SESSION: ${{ matrix.test }}
+          CONTROLLER_SUPPORT: "1"
+          TARGET_SUPPORT: "1"
+          DUT_CONFIG: "controller_and_target"
+          CFG_NAME: "ahb_controller_and_target_sim"
+          I3C_ROOT_DIR: ${{ github.workspace }}
+        run: |
+          source activate.sh
+          make config CFG_NAME=ahb_controller_and_target_sim
+          cd verification/cocotb && python -m nox -R -s "$TEST_SESSION" --no-venv --forcecolor
+
+      - name: Display test logs on failure
+        if: failure() && steps.run-test.outcome == 'failure'
+        run: |
+          echo "=== Test failed - displaying log files ==="
+          find verification/cocotb -name "*.log" -type f -exec sh -c \
+            'echo ""; echo "========================================"; echo "=== {} ==="; echo "========================================"; cat "{}"' \;
+
+      - name: Sanitize artifact name
+        if: always()
+        id: sanitize
+        run: |
+          NAME='${{ matrix.test }}'
+          SANITIZED=$(echo "$NAME" | sed "s/[()='\" ,]/_/g" | sed 's/__*/_/g' | sed 's/_$//')
+          echo "name=$SANITIZED" >> $GITHUB_OUTPUT
+
+      - name: Upload test artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-ahb-controller-and-target-${{ steps.sanitize.outputs.name }}
+          path: |
+            verification/cocotb/**/*.xml
+            verification/cocotb/**/*.log
+
+  # ===========================================================================
+  # Job: Run AHB-Controller Only Tests (Parallel)
+  # ===========================================================================
+  tests-ahb-controller-only:
+    name: "AHB-Ctrl Only: ${{ matrix.test }}"
+    needs: [generate-matrix, lint-testplans]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.generate-matrix.outputs.ahb-controller-only-matrix) }}
+    steps:
+      - name: Install system dependencies
+        run: |
+          sudo apt -qqy update
+          sudo apt -qqy --no-install-recommends install \
+            help2man libfl-dev make g++ git bison flex gperf \
+            libreadline-dev libbz2-dev autoconf
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Initialize submodules
+        run: git submodule update --init --recursive
+
+      - name: Cache Verilator installation
+        id: cache-verilator
+        uses: actions/cache@v4
+        with:
+          path: ~/verilator-install
+          key: verilator-install-${{ env.VERILATOR_VERSION }}-${{ runner.os }}
+
+      - name: Build Verilator (if not cached)
+        if: steps.cache-verilator.outputs.cache-hit != 'true'
+        run: |
+          git clone https://github.com/verilator/verilator -b ${{ env.VERILATOR_VERSION }}
+          cd verilator
+          autoconf
+          ./configure --prefix=$HOME/verilator-install
+          make -j$(nproc)
+          make install
+
+      - name: Add Verilator to PATH
+        run: |
+          echo "$HOME/verilator-install/bin" >> $GITHUB_PATH
+          echo "VERILATOR_ROOT=$HOME/verilator-install/share/verilator" >> $GITHUB_ENV
+
+      - name: Setup Python environment (pyenv + dependencies)
+        run: ./install.sh
+
+      - name: Configure RTL and run test
+        id: run-test
+        env:
+          TEST_SESSION: ${{ matrix.test }}
+          CONTROLLER_SUPPORT: "1"
+          TARGET_SUPPORT: "0"
+          DUT_CONFIG: "controller_only"
+          CFG_NAME: "ahb_controller_only_sim"
+          I3C_ROOT_DIR: ${{ github.workspace }}
+        run: |
+          source activate.sh
+          make config CFG_NAME=ahb_controller_only_sim
+          cd verification/cocotb && python -m nox -R -s "$TEST_SESSION" --no-venv --forcecolor
+
+      - name: Display test logs on failure
+        if: failure() && steps.run-test.outcome == 'failure'
+        run: |
+          echo "=== Test failed - displaying log files ==="
+          find verification/cocotb -name "*.log" -type f -exec sh -c \
+            'echo ""; echo "========================================"; echo "=== {} ==="; echo "========================================"; cat "{}"' \;
+
+      - name: Rename XML results to avoid collisions
+        if: always()
+        run: |
+          find verification/cocotb -name "*.xml" -exec sh -c 'mv "$1" "${1%.xml}_ctrl_only.xml"' _ {} \;
+
+      - name: Sanitize artifact name
+        if: always()
+        id: sanitize
+        run: |
+          NAME='${{ matrix.test }}'
+          SANITIZED=$(echo "$NAME" | sed "s/[()='\" ,]/_/g" | sed 's/__*/_/g' | sed 's/_$//')
+          echo "name=$SANITIZED" >> $GITHUB_OUTPUT
+
+      - name: Upload test artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-ahb-controller-only-${{ steps.sanitize.outputs.name }}
+          path: |
+            verification/cocotb/**/*.xml
+            verification/cocotb/**/*.log
+
   # ===========================================================================
   # Job: Run AXI Tests (Parallel)
   # ===========================================================================
@@ -578,7 +781,7 @@ jobs:
   # ===========================================================================
   test-results:
     name: Aggregate test results
-    needs: [tests-ahb, tests-axi, tests-axi-controller-and-target, tests-axi-controller-only]
+    needs: [tests-ahb, tests-ahb-controller-and-target, tests-ahb-controller-only, tests-axi, tests-axi-controller-and-target, tests-axi-controller-only]
     if: always()
     runs-on: ubuntu-latest
     steps:
@@ -606,11 +809,15 @@ jobs:
       - name: Verify all tests passed
         run: |
           if [ "${{ needs.tests-ahb.result }}" != "success" ] || \
+             [ "${{ needs.tests-ahb-controller-and-target.result }}" != "success" ] || \
+             [ "${{ needs.tests-ahb-controller-only.result }}" != "success" ] || \
              [ "${{ needs.tests-axi.result }}" != "success" ] || \
              [ "${{ needs.tests-axi-controller-and-target.result }}" != "success" ] || \
              [ "${{ needs.tests-axi-controller-only.result }}" != "success" ]; then
             echo "❌ Some tests failed!"
             echo "   AHB tests: ${{ needs.tests-ahb.result }}"
+            echo "   AHB-Ctrl and Target tests: ${{ needs.tests-ahb-controller-and-target.result }}"
+            echo "   AHB-Ctrl only tests: ${{ needs.tests-ahb-controller-only.result }}"
             echo "   AXI tests: ${{ needs.tests-axi.result }}"
             echo "   AXI-Ctrl and Target tests: ${{ needs.tests-axi-controller-and-target.result }}"
             echo "   AXI-Ctrl only tests: ${{ needs.tests-axi-controller-only.result }}"
