treewide: Various cleanup passes

* Consistent headers * Rename and relocate various files * Update README and CHANGELOG * Add linting pass to ensure consistent headers
pulp-platform · Nov 1, 2023 · 1d724c6 · 1d724c6
1 parent e3cd418
commit 1d724c6
Show file tree

Hide file tree

Showing 85 changed files with 377 additions and 160 deletions.
diff --git a/.github/authors-cfg.yaml b/.github/authors-cfg.yaml
@@ -0,0 +1,45 @@
+# Copyright 2023 ETH Zurich and University of Bologna.
+# Solderpad Hardware License, Version 0.51, see LICENSE for details.
+# SPDX-License-Identifier: SHL-0.51
+
+# Authors:
+# - Thomas Benz <tbenz@iis.ee.ethz.ch>
+
+header-regex: >
+  (?:#\!/.*\n)*[/|#]+ Copyright ([0-9]+) ETH Zurich and University of Bologna\.\n[/|#]+ Solderpad Hardware License, Version 0\.51, see LICENSE for details\.\n[/|#]+ SPDX-License-Identifier: SHL-0\.51\n\n[/|#]+ Authors:\n((?:[/#]+ - [0-9A-Za-z ]+<[0-9A-Za-z\.]+@[0-9A-Za-z\.]+>\n)+)
+
+author-regex: >
+  ([0-9A-Za-z ]+)<([0-9A-Za-z\.]+@[0-9A-Za-z\.]+)>
+
+excludes:
+  - LICENSE
+  - VERSION
+  - CODEOWNERS
+  - doc/fig/iDMA_overview
+  - util/lint-commits.py
+  - test/future/idma_tb_per2axi.sv
+  - test/future/TLToAXI4.v
+
+exclude-ext:
+  - png
+  - pyc
+  - rst
+  - svg
+  - txt
+  - json
+  - md
+  - lock
+  - local
+
+exclude-paths:
+  - target
+
+allowed-years:
+  - 2023
+
+allowed-authors:
+  Axel Vanoni: axvanoni@ethz.ch
+  Michael Rogenmoser: michaero@iis.ee.ethz.ch
+  Samuel Riedel: sriedel@iis.ee.ethz.ch
+  Thomas Benz: tbenz@iis.ee.ethz.ch
+  Tobias Senti: tsenti@ethz.ch
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -127,3 +127,22 @@ jobs:
       -
         name: Lint commits
         run: python3 util/lint-commits.py HEAD
+
+  lint-author:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Install Python
+        uses: actions/setup-python@v4
+        with:
+            python-version: '3.9'
+            cache: 'pip'
+      -
+        name: Python Requirements
+        run: pip install -r requirements.txt
+      -
+        name: Lint authors
+        run: python3 util/lint-authors.py .github/authors-cfg.yaml
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -1,4 +1,4 @@
-# Copyright 2022 ETH Zurich and University of Bologna.
+# Copyright 2023 ETH Zurich and University of Bologna.
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
 

diff --git a/Bender.local b/Bender.local
@@ -1,2 +1,9 @@
+# Copyright 2023 ETH Zurich and University of Bologna.
+# Solderpad Hardware License, Version 0.51, see LICENSE for details.
+# SPDX-License-Identifier: SHL-0.51
+
+# Authors:
+# - Thomas Benz <tbenz@iis.ee.ethz.ch>
+
 overrides:
   axi: { git: "https://github.com/pulp-platform/axi.git", version: 0.39.1 }
diff --git a/Bender.yml b/Bender.yml
@@ -1,7 +1,10 @@
-# Copyright 2022 ETH Zurich and University of Bologna.
+# Copyright 2023 ETH Zurich and University of Bologna.
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
 
+# Authors:
+# - Thomas Benz <tbenz@iis.ee.ethz.ch>
+
 package:
   name: idma
   authors:
@@ -74,21 +77,21 @@ sources:
     files:
       # Level 0
       - src/frontend/desc64/idma_desc64_synth_pkg.sv
-      - src/synth/idma_nd_backend_synth.sv
+      - src/midend/idma_nd_midend_synth.sv
       # Level 1
       - src/frontend/desc64/idma_desc64_synth.sv
 
   # Testbenches
   - target: test
     files:
       # Level 0
-      - test/tb_idma_improved_fifo.sv
-      - test/tb_idma_nd_backend.sv
       - test/frontend/tb_idma_desc64_top.sv
       - test/frontend/tb_idma_desc64_bench.sv
       - test/future/idma_tb_per2axi.sv
       - test/future/idma_obi_asserter.sv
       - test/future/TLToAXI4.v
+      - test/future/tb_idma_improved_fifo.sv
+      - test/midend/tb_idma_nd_midend.sv
       # Level 1
       - test/future/idma_obi2axi_bridge.sv
       - test/future/idma_tilelink2axi_bridge.sv
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Fixed
+
+### Changed
+- Various cleanup and modernization passes: CI, documentation, scripts
+- Rework ND-front-ends for both 32 and 64-bit systems [#30](https://github.com/pulp-platform/iDMA/pull/30),
+  [#32](https://github.com/pulp-platform/iDMA/pull/32), [#33](https://github.com/pulp-platform/iDMA/pull/33)
+- Remove default system wrappers and drivers
+- Update descriptor-based frontend [#18](https://github.com/pulp-platform/iDMA/pull/18),
+  [#26](https://github.com/pulp-platform/iDMA/pull/26)
+- Update tracer to the multiprotocol version of iDMA [#8](https://github.com/pulp-platform/iDMA/pull/8)
+
+### Added
+- Add true multiprotocol capabilities to iDMA using MARIO [#22](https://github.com/pulp-platform/iDMA/pull/22)
+- Add RT midend [#24](https://github.com/pulp-platform/iDMA/pull/24)
+- Add Mempool midend [#34](https://github.com/pulp-platform/iDMA/pull/34)
+
 ## 0.5.1 - 2023-10-21
 
 ### Fixed

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-# Copyright 2022 ETH Zurich and University of Bologna.
+# Copyright 2023 ETH Zurich and University of Bologna.
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
 

diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # iDMA
+[![CI status](https://github.com/pulp-platform/idma/actions/workflows/gitlab-ci.yml/badge.svg?branch=master)](https://github.com/pulp-platform/idma/actions/workflows/gitlab-ci.yml?query=branch%3Amaster)
 [![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/pulp-platform/iDMA?color=blue&label=current&sort=semver)](CHANGELOG.md)
 [![SHL-0.51 license](https://img.shields.io/badge/license-SHL--0.51-green)](LICENSE)
 

diff --git a/doc/src/conf.py b/doc/src/conf.py
@@ -1,7 +1,10 @@
-# Copyright 2022 ETH Zurich and University of Bologna.
+# Copyright 2023 ETH Zurich and University of Bologna.
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
-#
+
+# Authors:
+# - Michael Rogenmoser <michaero@iis.ee.ethz.ch>
+
 # Configuration file for the Sphinx documentation builder.
 #
 # This file does only contain a selection of the most common options. For a

diff --git a/idma.mk b/idma.mk
@@ -1,4 +1,4 @@
-# Copyright 2022 ETH Zurich and University of Bologna.
+# Copyright 2023 ETH Zurich and University of Bologna.
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
 
@@ -232,9 +232,9 @@ IDMA_RTL_DOC_ALL += $(foreach Y,$(IDMA_BACKEND_IDS),$(IDMA_HTML_DIR)/idma_backen
 IDMA_PICKLE_ALL  += $(foreach Y,$(IDMA_BACKEND_IDS),$(IDMA_PICKLE_DIR)/idma_backend_synth_$Y.sv)
 
 # nDs
-IDMA_RTL_DOC_ALL += $(IDMA_DOC_FIG_DIR)/graph/idma_nd_backend_synth.png
-IDMA_RTL_DOC_ALL += $(IDMA_HTML_DIR)/idma_nd_backend_synth/index.html
-IDMA_PICKLE_ALL  += $(IDMA_PICKLE_DIR)/idma_nd_backend_synth.sv
+IDMA_RTL_DOC_ALL += $(IDMA_DOC_FIG_DIR)/graph/idma_nd_midend_synth.png
+IDMA_RTL_DOC_ALL += $(IDMA_HTML_DIR)/idma_nd_midend_synth/index.html
+IDMA_PICKLE_ALL  += $(IDMA_PICKLE_DIR)/idma_nd_midend_synth.sv
 
 # descriptor-based frontend
 IDMA_RTL_DOC_ALL += $(IDMA_DOC_FIG_DIR)/graph/idma_desc64_synth.png
@@ -392,7 +392,7 @@ idma_spinx_doc_clean:
 
 IDMA_NONFREE_REMOTE ?= git@iis-git.ee.ethz.ch:bslk/idma/idma-non-free.git
 IDMA_NONFREE_DIR    ?= $(IDMA_ROOT)/nonfree
-IDMA_NONFREE_COMMIT ?= dev-tbenz
+IDMA_NONFREE_COMMIT ?= deploy
 
 idma_nonfree_init:
 	git clone $(IDMA_NONFREE_REMOTE) $(IDMA_NONFREE_DIR)

diff --git a/jobs/jobs.json b/jobs/jobs.json
@@ -129,8 +129,8 @@
             "ErrorHandling"       : 0
         },
         "proc_id" : "rw_axi",
-        "testbench": "tb_idma_nd_backend",
-        "synth_top": "idma_nd_backend_synth"
+        "testbench": "tb_idma_nd_midend",
+        "synth_top": "idma_nd_midend_synth"
     },
     "desc64": {
         "jobs" : {

diff --git a/scripts/list-contributors b/scripts/list-contributors
@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright 2022 ETH Zurich and University of Bologna.
+# Copyright 2023 ETH Zurich and University of Bologna.
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
 

diff --git a/scripts/list-todos b/scripts/list-todos
@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright 2022 ETH Zurich and University of Bologna.
+# Copyright 2023 ETH Zurich and University of Bologna.
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
 

diff --git a/src/backend/idma_axi_read.sv b/src/backend/idma_axi_read.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 `include "common_cells/registers.svh"

diff --git a/src/backend/idma_axi_write.sv b/src/backend/idma_axi_write.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 `include "common_cells/registers.svh"

diff --git a/src/backend/idma_axil_read.sv b/src/backend/idma_axil_read.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// Implementing the AXI Lite read task in the iDMA transport layer.

diff --git a/src/backend/idma_axil_write.sv b/src/backend/idma_axil_write.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// Implementing the AXI Lite write task in the iDMA transport layer.

diff --git a/src/backend/idma_axis_read.sv b/src/backend/idma_axis_read.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// Implementing the AXI Stream read task in the iDMA transport layer.

diff --git a/src/backend/idma_axis_write.sv b/src/backend/idma_axis_write.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// Implementing the AXI Stream write task in the iDMA transport layer.

diff --git a/src/backend/idma_channel_coupler.sv b/src/backend/idma_channel_coupler.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 
 `include "common_cells/registers.svh"
 `include "axi/typedef.svh"

diff --git a/src/backend/idma_dataflow_element.sv b/src/backend/idma_dataflow_element.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// A byte-granular buffer holding data while it is copied.

diff --git a/src/backend/idma_error_handler.sv b/src/backend/idma_error_handler.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 
 `include "common_cells/registers.svh"
 `include "common_cells/assertions.svh"

diff --git a/src/backend/idma_init_read.sv b/src/backend/idma_init_read.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// Implementing the INIT read task in the iDMA transport layer.

diff --git a/src/backend/idma_obi_read.sv b/src/backend/idma_obi_read.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// Implementing the OBI read task in the iDMA transport layer.

diff --git a/src/backend/idma_obi_write.sv b/src/backend/idma_obi_write.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 /// Implementing the OBI write task in the iDMA transport layer.

diff --git a/src/backend/idma_tilelink_read.sv b/src/backend/idma_tilelink_read.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 `include "common_cells/registers.svh"

diff --git a/src/backend/idma_tilelink_write.sv b/src/backend/idma_tilelink_write.sv
@@ -1,9 +1,9 @@
-// Copyright 2022 ETH Zurich and University of Bologna.
+// Copyright 2023 ETH Zurich and University of Bologna.
 // Solderpad Hardware License, Version 0.51, see LICENSE for details.
 // SPDX-License-Identifier: SHL-0.51
 
 // Authors:
-// - Thomas Benz <tbenz@iis.eeethz.ch>
+// - Thomas Benz <tbenz@iis.ee.ethz.ch>
 // - Tobias Senti <tsenti@ethz.ch>
 
 `include "common_cells/registers.svh"