If gen2

.github/workflows/ci.yml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 IObundle
+#
+# SPDX-License-Identifier: MIT
+
 name: CI
 
 # Set default shell as interactive (source ~/.bashrc)
@@ -29,6 +33,8 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
+      - name: Clean untracked files and directories (like old submodules)
+        run: git clean -ffdx
       - name: run test
         run: make pc-emul-test
 
@@ -43,8 +49,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
+      - name: Clean untracked files and directories (like old submodules)
+        run: git clean -ffdx
       - name: run test
-        run: nix-shell --run "make sim-test"
+        run: make sim-test
 
   cyclonev:
     runs-on: self-hosted
@@ -56,10 +64,12 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
+      - name: Clean untracked files and directories (like old submodules)
+        run: git clean -ffdx
       - name: init mem and no ext mem
-        run: make fpga-run BOARD=CYCLONEV-GT-DK INIT_MEM=1 USE_EXTMEM=0
+        run: make fpga-run BOARD=cyclonev_gt_dk INIT_MEM=1 USE_EXTMEM=0
       - name: no init mem and ext mem
-        run: make fpga-run BOARD=CYCLONEV-GT-DK INIT_MEM=0 USE_EXTMEM=1
+        run: make fpga-run BOARD=cyclonev_gt_dk INIT_MEM=0 USE_EXTMEM=1
 
   ku040:
     runs-on: self-hosted
@@ -71,60 +81,39 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
+      - name: Clean untracked files and directories (like old submodules)
+        run: git clean -ffdx
       - name: init mem and no ext mem
-        run: make fpga-run BOARD=AES-KU040-DB-G INIT_MEM=1 USE_EXTMEM=0
+        run: make fpga-run BOARD=aes_ku040_db_g INIT_MEM=1 USE_EXTMEM=0
       - name: no init mem and ext mem
-        run: make fpga-run BOARD=AES-KU040-DB-G INIT_MEM=0 USE_EXTMEM=1
+        run: make fpga-run BOARD=aes_ku040_db_g INIT_MEM=0 USE_EXTMEM=1
 
-  lib:
+  doc:
     runs-on: self-hosted
-    timeout-minutes: 10
+    timeout-minutes: 60
     if: ${{ !cancelled() }}
     needs: [ cyclonev ]
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: 'recursive'
-      - name: run LIB test
-        run: nix-shell --run "cd submodules/LIB; ./scripts/test.sh test"
-
-  uart:
-    runs-on: self-hosted
-    timeout-minutes: 5
-    if: ${{ !cancelled() }}
-    needs: [ lib ]
-
+
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - name: run uart test
-        run: make -C submodules/UART test
+      - name: Clean untracked files and directories (like old submodules)
+        run: git clean -ffdx
+      - name: doc test
+        run: make doc-test
 
-  cache:
+  reuse:
     runs-on: self-hosted
-    timeout-minutes: 20
+    timeout-minutes: 3
     if: ${{ !cancelled() }}
-    needs: [ cyclonev ]
+    needs: [ doc ]
 
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - name: run simulation test
-        run: make -C submodules/CACHE sim-test
-      - name: run fpga test
-        run: make -C submodules/CACHE fpga-test
-  doc:
-    runs-on: self-hosted
-    timeout-minutes: 60
-    if: ${{ !cancelled() }}
-    needs: [ cyclonev ]
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: 'recursive'
-      - name: doc test
-        run: nix-shell --run "make -C ../iob_soc_V* doc-test"
+      - name: Clean untracked files and directories (like old submodules)
+        run: git clean -ffdx
+      - name: Check compliance with REUSE specification
+        run: nix-shell --run "reuse lint"

.gitmodules

@@ -1,9 +1,4 @@
-[submodule "submodules/CACHE"]
-	path = submodules/CACHE
-	url = [email protected]:IObundle/iob-cache.git
-[submodule "submodules/PICORV32"]
-	path = submodules/PICORV32
-	url = [email protected]:IObundle/iob-picorv32.git
-[submodule "submodules/AXI"]
-	path = submodules/AXI
-	url = [email protected]:IObundle/verilog-axi.git
+# SPDX-FileCopyrightText: 2024 IObundle
+#
+# SPDX-License-Identifier: MIT
+

CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below. If you are contributor, submit a pull request to add you as an author."
+authors:
+- family-names: "T. de Sousa "
+  given-names: "Jose"
+  orcid: "https://orcid.org/0000-0001-7525-7546"
+title: "A RISC-V-based System-on-Chip Template"
+version: 0.7.2
+doi: 10.5281/zenodo.13346032
+date-released: 2021-12-18
+url: "https://github.com/IObundle/iob-soc"

CITATION.cff.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 IObundle
+
+SPDX-License-Identifier: MIT

LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -1,61 +1,57 @@
+# SPDX-FileCopyrightText: 2024 IObundle
+#
+# SPDX-License-Identifier: MIT
+
 CORE := iob_soc
 
 SIMULATOR ?= icarus
 SYNTHESIZER ?= yosys
-BOARD ?= CYCLONEV-GT-DK
-
-DISABLE_LINT:=1
+BOARD ?= cyclonev_gt_dk
 
-include submodules/LIB/setup.mk
+BUILD_DIR ?= $(shell nix-shell --run "py2hwsw $(CORE) print_build_dir")
 
 INIT_MEM ?= 1
 USE_EXTMEM ?= 0
 
-
-ifeq ($(INIT_MEM),1)
-SETUP_ARGS += INIT_MEM
-endif
-
-ifeq ($(USE_EXTMEM),1)
-SETUP_ARGS += USE_EXTMEM
+ifneq ($(DEBUG),)
+EXTRA_ARGS +=--debug_level $(DEBUG)
 endif
 
 setup:
-	nix-shell --run 'make build-setup SETUP_ARGS="$(SETUP_ARGS)"'
+	nix-shell --run "py2hwsw $(CORE) setup --no_verilog_lint --py_params 'init_mem=$(INIT_MEM):use_extmem=$(USE_EXTMEM)' $(EXTRA_ARGS)"
 
 pc-emul-run:
-	nix-shell --run 'make clean setup && make -C ../$(CORE)_V*/ pc-emul-run'
+	nix-shell --run "make clean setup && make -C ../$(CORE)_V*/ pc-emul-run"
 
 pc-emul-test:
-	nix-shell --run 'make clean setup && make -C ../$(CORE)_V*/ pc-emul-run'
+	nix-shell --run "make clean setup && make -C ../$(CORE)_V*/ pc-emul-run"
 
 sim-run:
-	nix-shell --run 'make clean setup INIT_MEM=$(INIT_MEM) USE_EXTMEM=$(USE_EXTMEM) && make -C ../$(CORE)_V*/ fw-build'
-	nix-shell --run 'make clean setup INIT_MEM=$(INIT_MEM) USE_EXTMEM=$(USE_EXTMEM) && make -C ../$(CORE)_V*/ sim-run SIMULATOR=$(SIMULATOR)'
+	nix-shell --run "make clean setup INIT_MEM=$(INIT_MEM) USE_EXTMEM=$(USE_EXTMEM) && make -C ../$(CORE)_V*/ sim-run SIMULATOR=$(SIMULATOR)"
 
 sim-test:
-	nix-shell --run 'make clean setup INIT_MEM=1 USE_EXTMEM=0 && make -C ../$(CORE)_V*/ sim-run SIMULATOR=icarus'
-	nix-shell --run 'make clean setup INIT_MEM=0 USE_EXTMEM=1 && make -C ../$(CORE)_V*/ sim-run SIMULATOR=verilator'
-	nix-shell --run 'make clean setup INIT_MEM=1 USE_EXTMEM=0 && make -C ../$(CORE)_V*/ sim-run SIMULATOR=verilator'
+	nix-shell --run "make clean setup INIT_MEM=1 USE_EXTMEM=0 && make -C ../$(CORE)_V*/ sim-run SIMULATOR=icarus"
+	nix-shell --run "make clean setup INIT_MEM=0 USE_EXTMEM=0 && make -C ../$(CORE)_V*/ sim-run SIMULATOR=verilator"
+	nix-shell --run "make clean setup INIT_MEM=0 USE_EXTMEM=1 && make -C ../$(CORE)_V*/ sim-run SIMULATOR=verilator"
 
 fpga-run:
-	nix-shell --run 'make clean setup INIT_MEM=$(INIT_MEM) USE_EXTMEM=$(USE_EXTMEM) && make -C ../$(CORE)_V*/ fpga-fw-build BOARD=$(BOARD)'
+	nix-shell --run "make clean setup INIT_MEM=$(INIT_MEM) USE_EXTMEM=$(USE_EXTMEM) && make -C ../$(CORE)_V*/ fpga-fw-build BOARD=$(BOARD)"
 	make -C ../$(CORE)_V*/ fpga-run BOARD=$(BOARD)
 
 fpga-test:
-	make clean setup fpga-run BOARD=CYCLONEV-GT-DK INIT_MEM=1 USE_EXTMEM=0 
-	make clean setup fpga-run BOARD=CYCLONEV-GT-DK INIT_MEM=0 USE_EXTMEM=1 
-	make clean setup fpga-run BOARD=AES-KU040-DB-G INIT_MEM=1 USE_EXTMEM=0 
-	make clean setup fpga-run BOARD=AES-KU040-DB-G INIT_MEM=0 USE_EXTMEM=1 
+	make clean setup fpga-run BOARD=cyclonev_gt_dk INIT_MEM=1 USE_EXTMEM=0
+	make clean setup fpga-run BOARD=cyclonev_gt_dk INIT_MEM=0 USE_EXTMEM=1
+	make clean setup fpga-run BOARD=aes_ku040_db_g INIT_MEM=1 USE_EXTMEM=0
+	make clean setup fpga-run BOARD=aes_ku040_db_g INIT_MEM=0 USE_EXTMEM=1
 
 syn-build: clean
-	nix-shell --run 'make setup && make -C ../$(CORE)_V*/ syn-build SYNTHESIZER=$(SYNTHESIZER)'
+	nix-shell --run "make setup && make -C ../$(CORE)_V*/ syn-build SYNTHESIZER=$(SYNTHESIZER)"
 
 doc-build:
-	nix-shell --run 'make clean setup && make -C ../$(CORE)_V*/ doc-build'
+	nix-shell --run "make clean setup && make -C ../$(CORE)_V*/ doc-build"
 
 doc-test:
-	nix-shell --run 'make clean setup && make -C ../$(CORE)_V*/ doc-test'
+	nix-shell --run "make clean setup && make -C ../$(CORE)_V*/ doc-test"
 
 
 test-all: pc-emul-test sim-test fpga-test doc-test
@@ -64,12 +60,24 @@ test-all: pc-emul-test sim-test fpga-test doc-test
 
 # Install board server and client
 board_server_install:
-	make -C submodules/LIB board_server_install
+	make -C lib board_server_install
 
 board_server_uninstall:
-	make -C submodules/LIB board_server_uninstall
+	make -C lib board_server_uninstall
 
 board_server_status:
 	systemctl status board_server
 
 .PHONY: setup sim-test fpga-test doc-test test-all board_server_install board_server_uninstall board_server_status
+
+
+clean:
+	nix-shell --run "py2hwsw $(CORE) clean --build_dir '$(BUILD_DIR)'"
+	@rm -rf ../*.summary ../*.rpt
+	@find . -name \*~ -delete
+
+# Remove all __pycache__ folders with python bytecode
+python-cache-clean:
+	find . -name "*__pycache__" -exec rm -rf {} \; -prune
+
+.PHONY: clean python-cache-clean