Merge branch 'main' into 219_change_names_ram_random

2024-04-25 11:20:29 +02:00 · 2024-04-25 11:20:29 +02:00 · a0eb82fe34
parent 3a5d2d80fb e961f46e79
commit a0eb82fe34
8 changed files with 77 additions and 28 deletions
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@ -10,7 +10,7 @@ on:
  workflow_dispatch: {}

 jobs:
-  ci:
+  check-firmware:
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/tillitis/tkey-builder:4
@ -26,7 +26,7 @@ jobs:
        run: |
          git config --global --add safe.directory "$GITHUB_WORKSPACE"

-      - name: check indentation of our firmware C code
+      - name: check indentation in firmware C code
        working-directory: hw/application_fpga
        run: |
          make -C fw/tk1 checkfmt
@ -37,10 +37,46 @@ jobs:
        run: |
          make check

+      - name: compile firmware and testfw
+        working-directory: hw/application_fpga
+        run: make firmware.bin testfw.bin
+
+  check-verilog:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/tillitis/tkey-builder:4
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          # fetch-depth: 0
+          persist-credentials: false
+
+      - name: fix
+        # https://github.com/actions/runner-images/issues/6775
+        run: |
+          git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
      - name: lint verilog using verilator
        working-directory: hw/application_fpga
        run: make lint

+  build-other-firmwares:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/tillitis/tkey-builder:4
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          # fetch-depth: 0
+          persist-credentials: false
+
+      - name: fix
+        # https://github.com/actions/runner-images/issues/6775
+        run: |
+          git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
      - name: compile ch552 firmware
        working-directory: hw/boards/mta1-usb-v1/ch552_fw
        run: make
@ -49,15 +85,28 @@ jobs:
        working-directory: hw/boards/tp1/firmware
        run: ./build.sh

+  build-bitstream:
+    outputs:
+      commit_sha: ${{ github.sha }}
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/tillitis/tkey-builder:4
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          # fetch-depth: 0
+          persist-credentials: false
+
+      - name: fix
+        # https://github.com/actions/runner-images/issues/6775
+        run: |
+          git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
      - name: make production test gateware
        working-directory: hw/production_test/application_fpga_test_gateware
        run: make

-      - name: compile firmware and testfw
-        working-directory: hw/application_fpga
-        run: make firmware.bin testfw.bin
-
-      # doing this last as it takes long time
      - name: make application FPGA gateware
        working-directory: hw/application_fpga
        run: make all
@ -68,16 +117,10 @@ jobs:
          path: |
            hw/application_fpga/application_fpga.bin
            hw/application_fpga/firmware.bin
-          key: ${{ runner.os }}-build-${{ github.sha }}
-          restore-keys: ${{ runner.os }}-build-
-
-
-      # TODO? first deal with hw/boards/ and hw/production_test/
-      # - name: check for SPDX tags
-      #   run: ./LICENSES/spdx-ensure
+          key: build-${{ github.run_number }}-${{ github.sha }}-${{ github.run_attempt }}

  check-hashes:
-    needs: ci
+    needs: build-bitstream
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/tillitis/tkey-builder:4
@ -93,9 +136,13 @@ jobs:
          path: |
            hw/application_fpga/application_fpga.bin
            hw/application_fpga/firmware.bin
-          key: ${{ runner.os }}-build-${{ needs.build.outputs.commit_sha }}
-          restore-keys: ${{ runner.os }}-build-
+          key: build-${{ github.run_number }}-${{ needs.build-bitstream.outputs.commit_sha }}-${{ github.run_attempt }}

      - name: check matching hashes for firmware.bin & application_fpga.bin
        working-directory: hw/application_fpga
        run: make check-binary-hashes
+
+
+      # TODO? first deal with hw/boards/ and hw/production_test/
+      # - name: check for SPDX tags
+      #   run: ./LICENSES/spdx-ensure
--- a/hw/application_fpga/core/timer/toolruns/Makefile
+++ b/hw/application_fpga/core/timer/toolruns/Makefile
@ -21,7 +21,7 @@ CC = iverilog
 CC_FLAGS = -Wall

 LINT = verilator
-LINT_FLAGS = +1364-2001ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME
+LINT_FLAGS = +1364-2005ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME


 all: top.sim core.sim
@ -67,7 +67,7 @@ help:
 	@echo "sim-top:      Run top level simulation."
 	@echo "sim-core:     Run core level simulation."
 	@echo "lint-core:    Lint core rtl source files."
-	@echo "lint-core:    Lint top rtl source files."
+	@echo "lint-top:     Lint top rtl source files."
 	@echo "clean:        Delete all built files."

 #===================================================================
--- a/hw/application_fpga/core/tk1/toolruns/Makefile
+++ b/hw/application_fpga/core/tk1/toolruns/Makefile
@ -18,7 +18,7 @@ CC = iverilog
 CC_FLAGS = -Wall

 LINT = verilator
-LINT_FLAGS = +1364-2001ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME
+LINT_FLAGS = +1364-2005ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME


 all: top.sim
--- a/hw/application_fpga/core/touch_sense/README.md
+++ b/hw/application_fpga/core/touch_sense/README.md
@ -1,16 +1,18 @@
 # touch_sense

-Core that handles touch senor events and provides them SW via an API.
+Core that handles touch sensor events and provides them to the SW via
+an API.

 ## Introduction

 This core implements a touch sensor handler. The core detects and
 holds events for SW to read. The touch sensor input is expected to be
 a change in level from low (0) to high (1). When an event is seen, the
-core will set a status bit that SW can read. SW must then clear the
-event by writing to the status register.
+core will set a status bit that SW can read.

-The user is expected to lift the finger between multiple touch events.
+SW must clear the captured event by writing to the status
+register. The core will wait for the sensor input to become low again
+before being able to detect another event.


 ## API
--- a/hw/application_fpga/core/touch_sense/toolruns/Makefile
+++ b/hw/application_fpga/core/touch_sense/toolruns/Makefile
@ -18,7 +18,7 @@ CC = iverilog
 CC_FLAGS = -Wall

 LINT = verilator
-LINT_FLAGS = +1364-2001ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME
+LINT_FLAGS = +1364-2005ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME


 all: top.sim
--- a/hw/application_fpga/core/trng/toolruns/Makefile
+++ b/hw/application_fpga/core/trng/toolruns/Makefile
@ -18,7 +18,7 @@ CC = iverilog
 CC_FLAGS = -Wall

 LINT = verilator
-LINT_FLAGS = +1364-2001ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME
+LINT_FLAGS = +1364-2005ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME


 all: top.sim
--- a/hw/application_fpga/core/uart/toolruns/Makefile
+++ b/hw/application_fpga/core/uart/toolruns/Makefile
@ -18,7 +18,7 @@ CC = iverilog
 CC_FLAGS = -Wall

 LINT = verilator
-LINT_FLAGS = +1364-2001ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME
+LINT_FLAGS = +1364-2005ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME


 all: top.sim
--- a/hw/application_fpga/core/uds/toolruns/Makefile
+++ b/hw/application_fpga/core/uds/toolruns/Makefile
@ -18,7 +18,7 @@ CC = iverilog
 CC_FLAGS = -Wall

 LINT = verilator
-LINT_FLAGS = +1364-2001ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME
+LINT_FLAGS = +1364-2005ext+ --lint-only  -Wall -Wno-fatal -Wno-DECLFILENAME


 all: top.sim