docs: Extend documentation + deploy with mkdocs

.github/workflows/floogen.yml

@@ -11,13 +11,14 @@ on:
   push:
     branches:
       - main
+      - develop
 
 jobs:
 
-  unit-test:
+  unit-test-pip:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
@@ -26,6 +27,26 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install .
+        python -m pip install --group dev
     - name: Run unit tests
       run: |
         python -m pytest -v
+
+  unit-test-uv:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Sync project + dev group
+        run: uv sync --locked --group dev
+
+      - name: Run unit tests
+        run: uv run -m pytest -v

.github/workflows/gitlab-ci.yml

@@ -11,6 +11,7 @@ on:
   push:
     branches:
       - main
+      - develop
 
 jobs:
   check:

.github/workflows/lint.yml

@@ -11,6 +11,7 @@ on:
   push:
     branches:
       - main
+      - develop
 
 jobs:
 
@@ -40,25 +41,14 @@ jobs:
         fail_on_error: true
         reviewdog_reporter: github-check
 
-  ##########
-  # PyLint #
-  ##########
-  pylint:
+  ########
+  # Ruff #
+  ########
+  ruff:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.10'
-        cache: 'pip'
-    - name: Install dependencies and package
-      run: |
-        python -m pip install --upgrade pip
-        pip install .
-    - name: Analysing the code with pylint
-      run: |
-        pylint $(git ls-files '*.py')
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
 
   #################
   # Check License #

.github/workflows/publish-docs.yml

@@ -0,0 +1,32 @@
+# Copyright 2024 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+# Author: Tim Fischer <[email protected]>
+
+name: publish-docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+
+  deploy:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: pip
+      - name: Install Python requirements
+        run: pip install .[docs]
+      - name: Deploy Documentation
+        run: mkdocs gh-deploy --force

.gitignore

@@ -48,6 +48,7 @@ docs/_rst/*
 docs/_build/*
 cover/*
 MANIFEST
+site
 
 # Per-project virtualenvs
 .venv*/
@@ -68,6 +69,7 @@ hw/test/jobs
 
 # QuestaSim
 work
+work_*
 work-vsim
 modelsim.ini
 transcript
@@ -95,3 +97,6 @@ measurements
 *.csv
 **/*.log
 reviewdog
+
+# Physical design repository
+pd

.gitlab-ci.yml

@@ -2,12 +2,14 @@
 # Solderpad Hardware License, Version 0.51, see LICENSE for details.
 # SPDX-License-Identifier: SHL-0.51
 
+# Author: Tim Fischer <[email protected]>
 # Author: Michael Rogenmoser <[email protected]>
 
 variables:
-  VSIM: questa-2023.4 vsim
+  QUESTA_SEPP: questa-2025.1
+  VCS_SEPP: vcs-2025.06
   BENDER: bender
-  PYTHON: /usr/local/anaconda3/bin/python
+  UV: /home/fischeti/.local/bin/uv
 
 stages:
   - init
@@ -63,12 +65,7 @@ compile-meshes:
       - DUT: [axi_mesh, nw_mesh]
         ROUTE_ALGO: [xy, src, id]
   script:
-    # Install `floogen`
-    - $PYTHON -m venv .venv
-    - source .venv/bin/activate
-    - pip install .
-    # Generate sources
-    - floogen -c floogen/examples/${DUT}_${ROUTE_ALGO}.yml -o generated --no-format
+    - $UV run floogen -c floogen/examples/${DUT}_${ROUTE_ALGO}.yml -o generated --no-format
     # Compile the network
     - make compile-sim EXTRA_BENDER_FLAGS="-t ${DUT}" WORK="work_${DUT}_${ROUTE_ALGO}" | tee compile.log 2>&1
     - '! grep "\*\* Error" compile.log'
@@ -125,3 +122,25 @@ morty:
   script:
     - $BENDER sources -f > source_list.txt
     - morty -f source_list.txt
+
+###################
+# Physical Design #
+###################
+
+init-pd:
+  stage: init
+  script:
+    - make init-pd
+  artifacts:
+    paths:
+      - pd/ci.yml
+
+subpipe:
+  stage: build
+  needs:
+    - init-pd
+  trigger:
+    include:
+      - artifact: pd/ci.yml
+        job: init-pd
+    strategy: depend

Bender.lock

@@ -7,8 +7,8 @@ packages:
     dependencies:
     - common_cells
   axi:
-    revision: 9402c8a9ce0a7b5253c3c29e788612d771e8b5d6
-    version: 0.39.3
+    revision: 78831b6feba265d5ee2683bbf42b4150f8a35c43
+    version: 0.39.8
     source:
       Git: https://github.com/pulp-platform/axi.git
     dependencies:
@@ -32,22 +32,28 @@ packages:
     dependencies:
     - common_cells
   common_cells:
-    revision: 0d67563b6b592549542544f1abc0f43e5d4ee8b4
-    version: 1.35.0
+    revision: 1d5c6fc3da60f0a920a5113b143624770bc1a279
+    version: null
     source:
       Git: https://github.com/pulp-platform/common_cells.git
     dependencies:
     - common_verification
     - tech_cells_generic
   common_verification:
-    revision: 9c07fa860593b2caabd9b5681740c25fac04b878
-    version: 0.2.3
+    revision: fb1885f48ea46164a10568aeff51884389f67ae3
+    version: 0.2.5
     source:
       Git: https://github.com/pulp-platform/common_verification.git
     dependencies: []
+  floo_noc_pd:
+    revision: null
+    version: null
+    source:
+      Path: pd
+    dependencies: []
   idma:
-    revision: 95f366e56f7e772c283fb3c8b343afc4a3978375
-    version: 0.6.2
+    revision: 28a36e5e07705549e59fc33db96ab681bc1ca88e
+    version: 0.6.5
     source:
       Git: https://github.com/pulp-platform/iDMA.git
     dependencies:
@@ -58,16 +64,16 @@ packages:
     - obi
     - register_interface
   obi:
-    revision: 1aa411df145c4ebdd61f8fed4d003c33f7b20636
-    version: 0.1.2
+    revision: 0155fc34e900c7c884e081c0a1114a247937ff69
+    version: 0.1.7
     source:
       Git: https://github.com/pulp-platform/obi.git
     dependencies:
     - common_cells
     - common_verification
   register_interface:
-    revision: ae616e5a1ec2b41e72d200e5ab09c65e94aebd3d
-    version: 0.4.4
+    revision: 8e8c209ea559d3b54f45cf30fcce95ce70ff5e49
+    version: 0.4.6
     source:
       Git: https://github.com/pulp-platform/register_interface.git
     dependencies:

Bender.yml

@@ -7,13 +7,15 @@ package:
   authors:
     - "Michael Rogenmoser <[email protected]>"
     - "Tim Fischer <[email protected]>"
+    - "Lorenzo leone <[email protected]>"
 
 dependencies:
   idma: { git: "https://github.com/pulp-platform/iDMA.git", version: 0.6.2 }
-  common_cells: { git: "https://github.com/pulp-platform/common_cells.git", version: 1.35.0 }
+  common_cells: { git: "https://github.com/pulp-platform/common_cells.git", rev: "master" } # Revert to a versioned release once available
   common_verification: { git: "https://github.com/pulp-platform/common_verification.git", version: 0.2.3 }
-  axi: { git: "https://github.com/pulp-platform/axi.git", version: 0.39.3 }
+  axi: { git: "https://github.com/pulp-platform/axi.git", version: 0.39.7 }
   axi_riscv_atomics: { git: "https://github.com/pulp-platform/axi_riscv_atomics.git", version: 0.8.2 }
+  floo_noc_pd: {path: ./pd}
 
 export_include_dirs:
   - hw/include
@@ -26,19 +28,27 @@ sources:
   - hw/floo_fifo.sv
   - hw/floo_cdc.sv
   - hw/floo_route_select.sv
-  - hw/floo_route_comp.sv
+  - hw/floo_id_translation.sv
   - hw/floo_vc_arbiter.sv
   - hw/floo_wormhole_arbiter.sv
   - hw/floo_simple_rob.sv
   - hw/floo_rob.sv
   - hw/floo_rob_wrapper.sv
-  - hw/floo_meta_buffer.sv
+  - hw/floo_reduction_sync.sv
+  - hw/floo_route_xymask.sv
   # Level 2
+  - hw/floo_route_select.sv
+  - hw/floo_route_comp.sv
+  - hw/floo_meta_buffer.sv
+  - hw/floo_reduction_arbiter.sv
+  # Level 3
+  - hw/floo_output_arbiter.sv
+  # Level 4
   - hw/floo_nw_join.sv
   - hw/floo_axi_chimney.sv
   - hw/floo_nw_chimney.sv
   - hw/floo_router.sv
-  # Level 3 (Wrappers)
+  # Level 5 (Wrappers)
   - hw/floo_axi_router.sv
   - hw/floo_nw_router.sv
 
@@ -70,6 +80,7 @@ sources:
       - hw/test/floo_axi_rand_slave.sv
       - hw/test/floo_dma_test_node.sv
       - hw/test/axi_reorder_compare.sv
+      - hw/test/axi_reorder_compare_multicast.sv
       - hw/test/axi_reorder_remap_compare.sv
       - hw/test/axi_bw_monitor.sv
       - hw/test/floo_hbm_model.sv
@@ -80,19 +91,36 @@ sources:
       - hw/tb/tb_floo_router.sv
       - hw/tb/tb_floo_rob.sv
       - hw/tb/tb_floo_vc_router.sv
+      - hw/tb/tb_floo_rob_multicast.sv
+
+  - target: all(any(floo_test, floo_synth), axi_mesh)
+    files:
+      - generated/floo_axi_mesh_noc_pkg.sv
+      - generated/floo_axi_mesh_noc.sv
 
   - target: all(floo_test, axi_mesh)
     include_dirs:
       - hw/test/include
     files:
-      - generated/floo_axi_mesh_noc_pkg.sv
-      - generated/floo_axi_mesh_noc.sv
       - hw/tb/tb_floo_axi_mesh.sv
 
+  - target: all(any(floo_test, floo_synth), nw_mesh)
+    files:
+      - generated/floo_nw_mesh_noc_pkg.sv
+      - generated/floo_nw_mesh_noc.sv
+
   - target: all(floo_test, nw_mesh)
     include_dirs:
       - hw/test/include
     files:
-      - generated/floo_nw_mesh_noc_pkg.sv
-      - generated/floo_nw_mesh_noc.sv
       - hw/tb/tb_floo_nw_mesh.sv
+
+  - target: all(floo_synth, synthesis)
+    files:
+    # Level 0
+    - hw/synth/floo_synth_params_pkg.sv
+    # Level 1
+    - hw/synth/floo_synth_axi_chimney.sv
+    - hw/synth/floo_synth_nw_chimney.sv
+    - hw/synth/floo_synth_axi_router.sv
+    - hw/synth/floo_synth_nw_router.sv