floogen: Add support for single-AXI networks (#69)

* hw(router): Add router wrapper for single-axi configs * floogen(link): Add `AxiLink` class * floogen(ni): Add `AxiNi` class * floogen(router): Add `AxiRouter` class * floogen(network): Support both single-AXI and narrow-wide configurations * floogen(tpl): Add templates for single-AXI configurations * floogen(examples): Rename `occamy_mesh` to `occamy_mesh_xy` * floogen(examples): Add new "narrow-wide" network type * floogen(examples): Add three new examples for single-AXI configurations * ci: Update name of config file * cfg: Fix network name of `occamy_mesh_xy` * docs: Update examples in README and floogen documentation * docs: Remove deprecated configurations and flags in FlooGen documentation * docs: Update CHANGELOG
pulp-platform · Sep 17, 2024 · aecb7fb · aecb7fb
1 parent 6c56140
commit aecb7fb
Show file tree

Hide file tree

Showing 21 changed files with 704 additions and 66 deletions.
diff --git a/.github/workflows/floogen.yml b/.github/workflows/floogen.yml
@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        examples: ["single_cluster", "occamy_mesh", "occamy_tree", "occamy_mesh_src", "terapool"]
+        examples: ["single_cluster", "occamy_mesh_xy", "occamy_tree", "occamy_mesh_src", "terapool"]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python

diff --git a/Bender.yml b/Bender.yml
@@ -38,6 +38,8 @@ sources:
   - hw/floo_axi_chimney.sv
   - hw/floo_nw_chimney.sv
   - hw/floo_router.sv
+  # Level 3 (Wrappers)
+  - hw/floo_axi_router.sv
   - hw/floo_nw_router.sv
 
   - target: vc_router

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,10 +15,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
   - The `RouteCfg` describes all the necessary routing information parameters required by the chimneys.
   - The `ChimneyCfg` describes all other parameters for the data path of the chimney (e.g. Mgr/Sbr port enable, number of oustanding transactions, RoB types & sizes, etc.)
 - The `floo_test_pkg` now defines default configurations for all the new configuration structs that are used by the testbenches.
+- Add `floo_axi_router` module, which is a wrapper similar to the `floo_nw_router` but for single-AXI configurations, and can be used in conjunction with `floo_axi_chimney`.
 
 #### FlooGen
 - The `data_width` and `user_width` fields for `protocols` are now also validated to be compatible with each other.
 - All the various `*Cfg`'s is now rendered by _FlooGen_, either in the `*_noc_pkg` or in the `*_noc` module itself.
+- Added support for single-AXI configuration networks.
 
 ### Changed
 
@@ -42,6 +44,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
   - The `direction` field in the `protocol` schema is no longer required, since the direction is determined when specifying `mgr_port_protocol` and `sbr_port_protocol`.
   - The `name` field must be unique now, since it is used by `mgr_port_protocol` and `sbr_port_protocol` to reference the exact protocol.
   - All examples were adapted to reflect those changes.
+- A FlooGen configuration file now requires a `network_type` field, to determine the type of network to generate. The options are `axi` for single-AXI networks and `narrow-wide` for the narrow-wide AXI configurations.
 
 ### Fixed
 

diff --git a/README.md b/README.md
@@ -162,16 +162,14 @@ The following example shows the configuration for a simple mesh topology with 4x
     use_id_table: true
 
   protocols:
-    - name: "example_axi"
+    - name: "axi_in"
       type: "AXI4"
-      direction: "manager"
       data_width: 64
       addr_width: 32
       id_width: 3
       user_width: 1
-    - name: "example_axi"
+    - name: "axi_out"
       type: "AXI4"
-      direction: "subordinate"
       data_width: 64
       addr_width: 32
       id_width: 3
@@ -184,9 +182,9 @@ The following example shows the configuration for a simple mesh topology with 4x
         base: 0x1000_0000
         size: 0x0004_0000
       mgr_port_protocol:
-        - "example_axi"
+        - "axi_in"
       sbr_port_protocol:
-        - "example_axi"
+        - "axi_out"
 
   routers:
     - name: "router"

diff --git a/docs/floogen.md b/docs/floogen.md
@@ -16,16 +16,14 @@ The following is an example of a configuration file for a 4x4 mesh network:
     use_id_table: true
 
   protocols:
-    - name: "example_axi"
+    - name: "axi_in"
       type: "AXI4"
-      direction: "manager"
       data_width: 64
       addr_width: 32
       id_width: 3
       user_width: 1
-    - name: "example_axi"
+    - name: "axi_out"
       type: "AXI4"
-      direction: "subordinate"
       data_width: 64
       addr_width: 32
       id_width: 3
@@ -38,9 +36,9 @@ The following is an example of a configuration file for a 4x4 mesh network:
         base: 0x1000_0000
         size: 0x0004_0000
       mgr_port_protocol:
-        - "example_axi"
+        - "axi_in"
       sbr_port_protocol:
-        - "example_axi"
+        - "axi_out"
 
   routers:
     - name: "router"
@@ -86,7 +84,6 @@ The protocols section describes the protocols used in the network. It is compose
 
 - `name`: name of the protocol. This will be used as a reference in the framework and in the generated RTL code to name the protocol module and the protocol signals. If the narrow-wide channels are used, they need to be named `narrow` and `wide` respectively.
 - `type`: Currently only `AXI4` is supported
-- `direction`: the direction of the protocol. It can be either `manager` or `subordinate`. If an endpoint is both manager and subordinate, two protocols need to be defined.
 - `data_width`: the data width of the protocol
 - `addr_width`: the address width of the protocol
 - `id_width`: the ID width of the protocol. Endpoints with different ID widths for the `manager` and `subordinate` protocols are supported.
@@ -159,7 +156,5 @@ where `<config_file>` is the configuration file and `<output_dir>` is the output
 Apart from the configuration file, `floogen` supports additional options to customize the generated RTL code. The following options are supported:
 
 - `--outdir`: the output directory where the generated RTL code will be placed. This is equivalent to the `-o` option. If it is not specified, the output is printed to stdout.
-- `--only-pkg`: only generate the package. This is useful if you want to test single IPs without generating a whole network.
-- `--pkg-outdir`: the output directory where the generated package will be placed. By default, the package in the `hw` folder is overwitten, since it is also the once that is used by `bender` for compiling the IPs. If you want to keep the original package, you can specify a different output directory here.
 - `--no-format`: do not format the generated RTL code. By default, the generated RTL code is formatted with verible format, for which the `verible-verilog-format` binary needs to be installed. If this option is set, the generated RTL code is not formatted.
 - `--visualize`: visualize the generated network. It will create a plot of the graph of the network. If the `--outdir` option is specified, the plot is saved in the output directory. Otherwise, it is shown in a window. This is mainly intended for a quick check of the generated network, not a tool for debugging.
diff --git a/floogen/examples/axi_mesh_id.yml b/floogen/examples/axi_mesh_id.yml
@@ -0,0 +1,81 @@
+# Copyright 2023 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+name: axi_mesh
+description: "AXI mesh configuration for FlooGen"
+network_type: "axi"
+
+routing:
+  route_algo: "ID"
+  use_id_table: true
+
+protocols:
+  - name: "axi_in"
+    protocol: "AXI4"
+    data_width: 64
+    addr_width: 48
+    id_width: 4
+    user_width: 1
+    type_prefix: # prevents `axi_axi` prefix
+  - name: "axi_out"
+    protocol: "AXI4"
+    data_width: 64
+    addr_width: 48
+    id_width: 2
+    user_width: 1
+    type_prefix: # prevents `axi_axi` prefix
+
+endpoints:
+  - name: "cluster"
+    array: [4, 4]
+    addr_range:
+      base: 0x0000_1000_0000
+      size: 0x0000_0004_0000
+    mgr_port_protocol:
+      - "axi_in"
+    sbr_port_protocol:
+      - "axi_out"
+  - name: "hbm"
+    array: [4]
+    addr_range:
+      base: 0x0000_8000_0000
+      size: 0x0000_4000_0000
+    sbr_port_protocol:
+      - "axi_out"
+  - name: "peripherals"
+    addr_range:
+      start: 0x0000_0000_0000
+      end: 0x0000_0fff_ffff
+    mgr_port_protocol:
+      - "axi_in"
+    sbr_port_protocol:
+      - "axi_out"
+
+routers:
+  - name: "router"
+    array: [4, 4]
+    degree: 5
+
+connections:
+  - src: "cluster"
+    dst: "router"
+    src_range:
+    - [0, 3]
+    - [0, 3]
+    dst_range:
+    - [0, 3]
+    - [0, 3]
+    dst_dir: "Eject"
+  - src: "hbm"
+    dst: "router"
+    src_range:
+    - [0, 3]
+    dst_range:
+    - [0, 0]
+    - [0, 3]
+    dst_dir: "West"
+  - src: "peripherals"
+    dst: "router"
+    dst_idx: [1, 3]
+    dst_dir: "North"
diff --git a/floogen/examples/axi_mesh_src.yml b/floogen/examples/axi_mesh_src.yml
@@ -0,0 +1,81 @@
+# Copyright 2023 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+name: axi_mesh
+description: "AXI mesh configuration for FlooGen"
+network_type: "axi"
+
+routing:
+  route_algo: "SRC"
+  use_id_table: true
+
+protocols:
+  - name: "axi_in"
+    protocol: "AXI4"
+    data_width: 64
+    addr_width: 48
+    id_width: 4
+    user_width: 1
+    type_prefix: # prevents `axi_axi` prefix
+  - name: "axi_out"
+    protocol: "AXI4"
+    data_width: 64
+    addr_width: 48
+    id_width: 2
+    user_width: 1
+    type_prefix: # prevents `axi_axi` prefix
+
+endpoints:
+  - name: "cluster"
+    array: [4, 4]
+    addr_range:
+      base: 0x0000_1000_0000
+      size: 0x0000_0004_0000
+    mgr_port_protocol:
+      - "axi_in"
+    sbr_port_protocol:
+      - "axi_out"
+  - name: "hbm"
+    array: [4]
+    addr_range:
+      base: 0x0000_8000_0000
+      size: 0x0000_4000_0000
+    sbr_port_protocol:
+      - "axi_out"
+  - name: "peripherals"
+    addr_range:
+      start: 0x0000_0000_0000
+      end: 0x0000_0fff_ffff
+    mgr_port_protocol:
+      - "axi_in"
+    sbr_port_protocol:
+      - "axi_out"
+
+routers:
+  - name: "router"
+    array: [4, 4]
+    degree: 5
+
+connections:
+  - src: "cluster"
+    dst: "router"
+    src_range:
+    - [0, 3]
+    - [0, 3]
+    dst_range:
+    - [0, 3]
+    - [0, 3]
+    dst_dir: "Eject"
+  - src: "hbm"
+    dst: "router"
+    src_range:
+    - [0, 3]
+    dst_range:
+    - [0, 0]
+    - [0, 3]
+    dst_dir: "West"
+  - src: "peripherals"
+    dst: "router"
+    dst_idx: [1, 3]
+    dst_dir: "North"
diff --git a/floogen/examples/axi_mesh_xy.yml b/floogen/examples/axi_mesh_xy.yml
@@ -0,0 +1,81 @@
+# Copyright 2023 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+name: axi_mesh
+description: "AXI mesh configuration for FlooGen"
+network_type: "axi"
+
+routing:
+  route_algo: "XY"
+  use_id_table: true
+
+protocols:
+  - name: "axi_in"
+    protocol: "AXI4"
+    data_width: 64
+    addr_width: 48
+    id_width: 4
+    user_width: 1
+    type_prefix: # prevents `axi_axi` prefix
+  - name: "axi_out"
+    protocol: "AXI4"
+    data_width: 64
+    addr_width: 48
+    id_width: 2
+    user_width: 1
+    type_prefix: # prevents `axi_axi` prefix
+
+endpoints:
+  - name: "cluster"
+    array: [4, 4]
+    addr_range:
+      base: 0x0000_1000_0000
+      size: 0x0000_0004_0000
+    mgr_port_protocol:
+      - "axi_in"
+    sbr_port_protocol:
+      - "axi_out"
+  - name: "hbm"
+    array: [4]
+    addr_range:
+      base: 0x0000_8000_0000
+      size: 0x0000_4000_0000
+    sbr_port_protocol:
+      - "axi_out"
+  - name: "peripherals"
+    addr_range:
+      start: 0x0000_0000_0000
+      end: 0x0000_0fff_ffff
+    mgr_port_protocol:
+      - "axi_in"
+    sbr_port_protocol:
+      - "axi_out"
+
+routers:
+  - name: "router"
+    array: [4, 4]
+    degree: 5
+
+connections:
+  - src: "cluster"
+    dst: "router"
+    src_range:
+    - [0, 3]
+    - [0, 3]
+    dst_range:
+    - [0, 3]
+    - [0, 3]
+    dst_dir: "Eject"
+  - src: "hbm"
+    dst: "router"
+    src_range:
+    - [0, 3]
+    dst_range:
+    - [0, 0]
+    - [0, 3]
+    dst_dir: "West"
+  - src: "peripherals"
+    dst: "router"
+    dst_idx: [1, 3]
+    dst_dir: "North"
diff --git a/floogen/examples/occamy_mesh_src.yml b/floogen/examples/occamy_mesh_src.yml
@@ -4,6 +4,7 @@
 
 name: occamy_mesh_src
 description: "Occamy mesh configuration for FlooGen with source-based routing"
+network_type: "narrow-wide"
 
 routing:
   route_algo: "SRC"

diff --git a/floogen/examples/occamy_mesh.yml → floogen/examples/occamy_mesh_xy.yml b/floogen/examples/occamy_mesh.yml → floogen/examples/occamy_mesh_xy.yml
@@ -2,8 +2,9 @@
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
 
-name: occamy_mesh
+name: occamy_mesh_xy
 description: "Occamy mesh configuration for FlooGen"
+network_type: "narrow-wide"
 
 routing:
   route_algo: "XY"

diff --git a/floogen/examples/occamy_tree.yml b/floogen/examples/occamy_tree.yml
@@ -4,6 +4,7 @@
 
 name: occamy_tree
 description: "Occamy configuration for FlooGen"
+network_type: "narrow-wide"
 
 routing:
   route_algo: "ID"

diff --git a/floogen/examples/single_cluster.yml b/floogen/examples/single_cluster.yml
@@ -4,6 +4,7 @@
 
 name: single_cluster
 description: "Single Cluster Configuration for FlooGen"
+network_type: "narrow-wide"
 
 routing:
   route_algo: "ID"