From c9a05d6bb06c676d8fffba986273ed298d5dff43 Mon Sep 17 00:00:00 2001 From: <> Date: Tue, 10 Sep 2024 16:13:12 +0000 Subject: [PATCH] Deployed e0e0504 with MkDocs version: 1.6.1 --- 404.html | 2 +- changelog/index.html | 2 +- floogen/cli/index.html | 2 +- floogen/connections/index.html | 2 +- floogen/endpoints/index.html | 2 +- floogen/index.html | 131 +++++++++++--------------- floogen/known_issues/index.html | 2 +- floogen/overview/index.html | 2 +- floogen/protocols/index.html | 2 +- floogen/routers/index.html | 2 +- floogen/routing/index.html | 2 +- getting_started/index.html | 158 +++++++++++++++++++++++++++++--- hw/chimneys/index.html | 2 +- hw/common/index.html | 2 +- hw/links/index.html | 2 +- hw/overview/index.html | 2 +- hw/router/index.html | 2 +- hw/vips/index.html | 2 +- index.html | 2 +- repository_structure/index.html | 2 +- sitemap.xml | 38 ++++---- sitemap.xml.gz | Bin 344 -> 344 bytes 22 files changed, 238 insertions(+), 125 deletions(-) diff --git a/404.html b/404.html index 8625d09f..d0cfc705 100644 --- a/404.html +++ b/404.html @@ -918,7 +918,7 @@

404 - Not found

- + diff --git a/changelog/index.html b/changelog/index.html index 4b9e15c6..ed3a8714 100644 --- a/changelog/index.html +++ b/changelog/index.html @@ -1779,7 +1779,7 @@

Added

- + diff --git a/floogen/cli/index.html b/floogen/cli/index.html index 071e62d0..35349540 100644 --- a/floogen/cli/index.html +++ b/floogen/cli/index.html @@ -1055,7 +1055,7 @@

CLI

- + diff --git a/floogen/connections/index.html b/floogen/connections/index.html index b08bff3e..92abc137 100644 --- a/floogen/connections/index.html +++ b/floogen/connections/index.html @@ -1055,7 +1055,7 @@

Connections

- + diff --git a/floogen/endpoints/index.html b/floogen/endpoints/index.html index b2b99934..827430b0 100644 --- a/floogen/endpoints/index.html +++ b/floogen/endpoints/index.html @@ -1055,7 +1055,7 @@

Endpoints

- + diff --git a/floogen/index.html b/floogen/index.html index 1552ff95..6764bea2 100644 --- a/floogen/index.html +++ b/floogen/index.html @@ -1040,55 +1040,55 @@

Introduction

floogen is a framework for generating FlooNoC networks on chip. It allows to generate SystemVerilog RTL code for a given network configuration given by a configuration file written in YAML format. This document describes the configuration file format and how write your own configuration file to generate a FlooNoC network.

Configuration file format

The following is an example of a configuration file for a 4x4 mesh network:

-
  name: example_system
-  description: "Example of a configuration file"
-
-  routing:
-    route_algo: "XY"
-    use_id_table: true
-
-  protocols:
-    - name: "example_axi"
-      type: "AXI4"
-      direction: "manager"
-      data_width: 64
-      addr_width: 32
-      id_width: 3
-      user_width: 1
-    - name: "example_axi"
-      type: "AXI4"
-      direction: "subordinate"
-      data_width: 64
-      addr_width: 32
-      id_width: 3
-      user_width: 1
-
-  endpoints:
-    - name: "cluster"
-      array: [4, 4]
-      addr_range:
-        base: 0x1000_0000
-        size: 0x0004_0000
-      mgr_port_protocol:
-        - "example_axi"
-      sbr_port_protocol:
-        - "example_axi"
-
-  routers:
-    - name: "router"
-      array: [4, 4]
-
-  connections:
-    - src: "cluster"
-      dst: "router"
-      src_range:
-      - [0, 3]
-      - [0, 3]
-      dst_range:
-      - [0, 3]
-      - [0, 3]
-      bidirectional: true
-
+
  name: example_system
+  description: "Example of a configuration file"
+
+  routing:
+    route_algo: "XY"
+    use_id_table: true
+
+  protocols:
+    - name: "example_axi"
+      type: "AXI4"
+      direction: "manager"
+      data_width: 64
+      addr_width: 32
+      id_width: 3
+      user_width: 1
+    - name: "example_axi"
+      type: "AXI4"
+      direction: "subordinate"
+      data_width: 64
+      addr_width: 32
+      id_width: 3
+      user_width: 1
+
+  endpoints:
+    - name: "cluster"
+      array: [4, 4]
+      addr_range:
+        base: 0x1000_0000
+        size: 0x0004_0000
+      mgr_port_protocol:
+        - "example_axi"
+      sbr_port_protocol:
+        - "example_axi"
+
+  routers:
+    - name: "router"
+      array: [4, 4]
+
+  connections:
+    - src: "cluster"
+      dst: "router"
+      src_range:
+      - [0, 3]
+      - [0, 3]
+      dst_range:
+      - [0, 3]
+      - [0, 3]
+      bidirectional: true
+

but let's go step by step.

System description

The first part of the configuration file is the system description. It is composed by the following fields:

@@ -1157,11 +1157,11 @@

Connections

src_lvl or dst_lvl: the level of the source or destination. This is the level of the tree where the router is located. The root router is at level 0, the children routers are at level 1, and so on. This is useful to connect endpoints to the root router or to connect endpoints to the children routers.

Running floogen

floogen is a Python package that can be installed with pip:

-
pip install .
-
+
pip install .
+

Once installed, you can run floogen with the following command:

-
floogen -c <config_file> -o <output_dir>
-
+
floogen -c <config_file> -o <output_dir>
+

where <config_file> is the configuration file and <output_dir> is the output directory where the generated RTL code will be placed.

Additonal arguments

Apart from the configuration file, floogen supports additional options to customize the generated RTL code. The following options are supported:

@@ -1210,29 +1210,6 @@

Additonal arguments

- - - - - - - - GitHub - - - - - - @@ -1275,7 +1252,7 @@

Additonal arguments

- + diff --git a/floogen/known_issues/index.html b/floogen/known_issues/index.html index 2b16710d..ed90b8c8 100644 --- a/floogen/known_issues/index.html +++ b/floogen/known_issues/index.html @@ -1055,7 +1055,7 @@

Known Issues

- + diff --git a/floogen/overview/index.html b/floogen/overview/index.html index 884237b2..175e8c1e 100644 --- a/floogen/overview/index.html +++ b/floogen/overview/index.html @@ -1055,7 +1055,7 @@

Overview

- + diff --git a/floogen/protocols/index.html b/floogen/protocols/index.html index 503630d9..60c57852 100644 --- a/floogen/protocols/index.html +++ b/floogen/protocols/index.html @@ -1055,7 +1055,7 @@

Protocols

- + diff --git a/floogen/routers/index.html b/floogen/routers/index.html index 1811c409..25e4f3ec 100644 --- a/floogen/routers/index.html +++ b/floogen/routers/index.html @@ -1055,7 +1055,7 @@

Routers

- + diff --git a/floogen/routing/index.html b/floogen/routing/index.html index 8696b0f4..d3ccad16 100644 --- a/floogen/routing/index.html +++ b/floogen/routing/index.html @@ -1055,7 +1055,7 @@

Routing

- + diff --git a/getting_started/index.html b/getting_started/index.html index 5843fed1..7f3a99c2 100644 --- a/getting_started/index.html +++ b/getting_started/index.html @@ -102,7 +102,7 @@
- + Skip to content @@ -449,6 +449,8 @@ + +
- + diff --git a/hw/chimneys/index.html b/hw/chimneys/index.html index 791da104..1df653f6 100644 --- a/hw/chimneys/index.html +++ b/hw/chimneys/index.html @@ -1063,7 +1063,7 @@

Network interfaces (a.k.a. chimneys) - + diff --git a/hw/common/index.html b/hw/common/index.html index 8690dd8d..072aa8b5 100644 --- a/hw/common/index.html +++ b/hw/common/index.html @@ -1063,7 +1063,7 @@

Common IPs

- + diff --git a/hw/links/index.html b/hw/links/index.html index 245b7388..02f465da 100644 --- a/hw/links/index.html +++ b/hw/links/index.html @@ -1063,7 +1063,7 @@

Link-level protocol

- + diff --git a/hw/overview/index.html b/hw/overview/index.html index 6debc598..01ec01c5 100644 --- a/hw/overview/index.html +++ b/hw/overview/index.html @@ -1063,7 +1063,7 @@

Overview of the Hardware Components - + diff --git a/hw/router/index.html b/hw/router/index.html index e24a036f..949038ba 100644 --- a/hw/router/index.html +++ b/hw/router/index.html @@ -1063,7 +1063,7 @@

Routers

- + diff --git a/hw/vips/index.html b/hw/vips/index.html index 5cfa8d76..8ac8d600 100644 --- a/hw/vips/index.html +++ b/hw/vips/index.html @@ -1063,7 +1063,7 @@

Verification IPs (VIPs) of FlooNoC - + diff --git a/index.html b/index.html index 7faff081..bd41d4b0 100644 --- a/index.html +++ b/index.html @@ -1054,7 +1054,7 @@

Getting Started

- + diff --git a/repository_structure/index.html b/repository_structure/index.html index c80613c3..32459302 100644 --- a/repository_structure/index.html +++ b/repository_structure/index.html @@ -1155,7 +1155,7 @@

The floogen FlooGen - + diff --git a/sitemap.xml b/sitemap.xml index b5815f3a..2c419d36 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,78 +2,78 @@ https://pulp-platform.github.io/FlooNoC/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/changelog/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/getting_started/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/repository_structure/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/cli/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/connections/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/endpoints/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/known_issues/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/overview/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/protocols/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/routers/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/floogen/routing/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/hw/chimneys/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/hw/common/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/hw/links/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/hw/overview/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/hw/router/ - 2024-09-09 + 2024-09-10 https://pulp-platform.github.io/FlooNoC/hw/vips/ - 2024-09-09 + 2024-09-10 \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 58afcebdc75efe0c908145f5ef7e194ed92f5cb0..af074144b455d79d8ea1ec37d863461f4c035abe 100644 GIT binary patch literal 344 zcmV-e0jK^SiwFn+jNfJg|8r?{Wo=<_E_iKh0L_-oZo?o9fbV^ZDEEZ4+F_m2^f0N% zowjq85jQ~v8-bIoZ$I}()9yVGUku3Dp8(s``yXes2|_f4yL??%c?PJdGuZF)ug^pA zn(v!cJq8-rvAb` z6Ic%|_F$<`hj0?z1EvG$fmz)Iix^y4`JjuJFa1oX;Y90fmzZY%I0w4$xG)o4@ z^e}*(Cxg5Ilrz$dM-$@+3!ovXvXg;1J&6y*q{%MePy&rC&1V@PQs>fv472nb;}9+} qEd)77m=wVpJf}T`^tmb!_uNQ|Fd6^EMckBp8=GHI#8cvC3IG5DnxBmT literal 344 zcmV-e0jK^SiwFpSI^Jdi|8r?{Wo=<_E_iKh0L_+5Z^IxAfbabkQSJ?CwZl54>0wfj zJ8kDGBW{8UHUiVE|9Mx(s;)L=yC|ex72IdH)>zW* zRZA2#K3Tu?w&NoOR}F^8^j#TJdrR~|@2XK(>Hmkj$d3AUU9Vr3^+vjgJofI^)StO$ z4C}GO0W1yq5RNhqfcXFhV3xaZh};E+J|9Q`Pjas)T!bYg%_%_sxM*u;06~bLSu!~0 zhXL$88RQwDoRB6wm>3hxfQF>Xo()X-NqitCO?C!O36xkKpLu{toy!L@PV(Luhj58` qA;>wxtO(ZNDX$aq=c+*5b0aIl+4v^{aU0~@*!}{m)S|Iw3IG7)AEaLZ