Merge branch 'master' into init_noc_sa

Author: vaughnbetz

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+
+updates:
+
+  # Monthly update of submodules.
+  # This dependabot will create a PR if there are any updates to the submodules.
+  - package-ecosystem: gitsubmodule
+    schedule:
+        interval: "monthly"
+
+    # Update all submodules
+    directory: /

.github/workflows/containers.yml

@@ -17,7 +17,9 @@ jobs:
 
       - name: 🧰 Repository Checkout
         uses: actions/checkout@v3
-
+        with:
+          submodules: 'true'
+  
       - name: 🔧 Generate image name
         id: generate
         run: |

.github/workflows/test.yml

@@ -50,6 +50,8 @@ jobs:
     steps:
 
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
 
     - name: Setup
       run: stdbuf -i0 -i0 -e0 ./.github/scripts/hostsetup.sh
@@ -92,6 +94,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2
@@ -135,6 +139,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - name: Test
@@ -152,6 +158,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2
@@ -220,6 +228,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2
@@ -273,6 +283,9 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
+
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2
@@ -298,6 +311,8 @@ jobs:
         with:
           python-version: 3.10.10
       - uses: actions/checkout@v3
+        with:
+          submodules: 'true'
       - run: ./.github/scripts/install_dependencies.sh
 
       - uses: hendrikmuhs/ccache-action@v1.2
@@ -321,6 +336,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2
@@ -344,6 +361,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2
@@ -377,6 +396,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2
@@ -411,6 +432,8 @@ jobs:
       with:
         python-version: 3.10.10
     - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
     - run: ./.github/scripts/install_dependencies.sh
 
     - uses: hendrikmuhs/ccache-action@v1.2

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "libs/EXTERNAL/libcatch2"]
+	path = libs/EXTERNAL/libcatch2
+	url = https://github.com/catchorg/Catch2.git

BUILDING.md

@@ -3,6 +3,10 @@
 
 ## Setting up Your Environment
 
+If you cloned the repository you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
+
+    git submodule init
+    git submodule update
 
 VTR requires several system packages.  From the top-level directory, run the following script to install the required packages on a modern Debian or Ubuntu system:
 

doc/src/quickstart/index.rst

@@ -17,6 +17,13 @@ The first step is to `download VTR <https://verilogtorouting.org/download/>`_ an
 
 Environment Setup
 -----------------
+If you cloned the repository you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
+
+.. code-block:: bash
+
+    > git submodule init
+    > git submodule update
+    
 VTR requires several system packages and Python packages to build and run the flow.  You can install the required system packages using the following command (this works on Ubuntu 18.04, 20.04 and 22.04, but you may require different packages on other Linux distributions). Our CI testing is on Ubuntu 22.04, so that is the best tested platform and recommended for development.
 
 .. code-block:: bash

doc/src/vpr/command_line_usage.rst

@@ -1120,6 +1120,14 @@ VPR uses a negotiated congestion algorithm (based on Pathfinder) to perform rout
 
 .. seealso:: :ref:`timing_driven_router_options`
 
+.. option:: --flat_routing {on | off}
+
+    If this option is enabled, the *run-flat* router is used instead of the *two-stage* router.
+    This means that during the routing stage, all nets, both intra- and inter-cluster, are routed directly from one primitive pin to another primitive pin.
+    This increases routing time but can improve routing quality by re-arranging LUT inputs and exposing additional optimization opportunities in architectures with local intra-cluster routing that is not a full crossbar.
+
+    **Default:** ``OFF`
+
 .. option:: --max_router_iterations <int>
 
     The number of iterations of a Pathfinder-based router that will be executed before a circuit is declared unrouteable (if it hasn’t routed successfully yet) at a given channel width.