Merge branch 'master' into init_noc_sa

# Conflicts:
#	vpr/src/place/initial_placement.cpp
#	vpr/src/place/move_utils.cpp
#	vpr/src/place/move_utils.h
#	vpr/src/place/noc_place_utils.cpp
#	vpr/src/place/place_checkpoint.cpp
#	vpr/src/place/place_checkpoint.h

Author: soheilshahrouz

doc/.DS_Store

@@ -2,7 +2,7 @@
 # used by Read The Docs to install python required
 # modules with pip.
 
-sphinx
+sphinx<7
 sphinx_rtd_theme
 
 # Support custom domains

doc/requirements.txt

@@ -7,6 +7,7 @@ VPR API
    :maxdepth: 1
 
    contexts
-   netlist
    mapping
+   netlist
+   route_tree
    rr_graph

doc/src/.DS_Store

@@ -0,0 +1,22 @@
+========
+Route Tree
+========
+
+RouteTree
+-------
+
+.. doxygenfile:: route_tree.h
+   :project: vpr
+   :sections: detaileddescription
+
+
+.. doxygenclass:: RouteTree
+   :project: vpr
+   :members:
+
+RouteTreeNode
+-------------
+
+.. doxygenclass:: RouteTreeNode
+   :project: vpr
+   :members:

doc/src/Images/.DS_Store

@@ -9,3 +9,4 @@ VPR INTERNALS
    draw_structs
    vpr_ui
    draw_files
+   vpr_noc

doc/src/Images/Block_Settings.png

@@ -0,0 +1,8 @@
+==============
+NoC Data Types
+==============
+
+Data Types
+----------
+.. doxygenfile:: noc_data_types.h
+   :project: vpr

doc/src/Images/Net_Settings.png

@@ -0,0 +1,8 @@
+========
+NoC Link
+========
+
+NocLink
+-------
+.. doxygenfile:: noc_link.h
+   :project: vpr

doc/src/Images/Overall_view.png

@@ -0,0 +1,8 @@
+==========
+NoC Router
+==========
+
+NocRouter
+---------
+.. doxygenfile:: noc_router.h
+   :project: vpr

doc/src/Images/Routing_Options.png

@@ -0,0 +1,23 @@
+===========
+NoC Routing
+===========
+
+NocRouting
+---------------
+.. doxygenfile:: noc_routing.h
+   :project: vpr
+
+NocRoutingAlgorithmCreator
+--------------------------
+.. doxygenfile:: noc_routing_algorithm_creator.h
+   :project: vpr
+
+XYRouting
+---------
+.. doxygenfile:: xy_routing.h
+   :project: vpr
+
+BFSRouting
+----------
+.. doxygenfile:: bfs_routing.h
+   :project: vpr

doc/src/Images/crit_path.png

@@ -0,0 +1,8 @@
+===========
+NoC Storage
+===========
+
+NocStorage
+----------
+.. doxygenfile:: noc_storage.h
+   :project: vpr

doc/src/Images/manual_move.png

@@ -0,0 +1,8 @@
+=================
+NoC Traffic Flows
+=================
+
+NocTrafficFlows
+---------------
+.. doxygenfile:: noc_traffic_flows.h
+   :project: vpr

doc/src/api/vpr/index.rst

@@ -0,0 +1,15 @@
+.. _noc:
+
+=======
+VPR NoC
+=======
+
+.. toctree::
+   :maxdepth: 1
+
+   noc_router
+   noc_link
+   noc_storage
+   noc_traffic_flows
+   noc_routing 
+   noc_data_types  

doc/src/api/vpr/route_tree.rst

@@ -23,6 +23,7 @@ The architecture tag contains the following tags:
 * ``<segmentlist>``
 * ``<directlist>``
 * ``<complexblocklist>``
+* ``<noc>``
 
 .. _arch_models:
 
@@ -136,6 +137,10 @@ Global FPGA Information
 
     Content inside this tag contains a group of ``<pb_type>`` tags that specify the types of functional blocks and their properties.
 
+.. arch:tag:: <noc link_bandwidth="float" link_latency="float" router_latency="float" noc_router_tile_name="string">content</noc>
+    
+    Content inside this tag specifies the Network-on-Chip (NoC) architecture on the FPGA device and its properties.
+
 .. _arch_grid_layout:
 
 FPGA Grid Layout
@@ -1855,6 +1860,95 @@ Power
     :opt_param scaled_by_static_prob: Port name by which to scale ``energy_per_toggle`` based on its logic high probability.
     :opt_param scaled_by_static_prob_n: Port name by which to scale ``energy_per_toggle`` based on its logic low probability.
 
+NoC Description
+---------------
+
+The ``<noc>`` tag is an optional tag and its contents allows designers to describe a NoC on an FPGA device.
+The ``<noc>`` tag is the top level tag for the NoC description and its attributes define the overall properties
+of the NoC; refer below for its contents.
+
+.. arch:tag:: <noc link_bandwidth="float" link_latency="float" router_latency="float" noc_router_tile_name="string">
+
+    :req_param link_bandwidth:
+        Specifies the maximum bandwidth in bits-per-second (bps) that a link in the NoC can support
+
+    :req_param link_latency:
+        Specifies the delay in seconds seen by a flit as it travels from one physical NoC router to another using a NoC link.
+
+    :req_param router_latency:
+        Specifies the un-loaded delays in seconds as it travels through a physical router.
+    
+    :req_param noc_router_tile_name:
+        Specifies a string which represents the name used to identify a NoC router tile (physical hard block) in the 
+        corresponding FPGA architecture. This information is needed to create a model of the NoC.
+
+The ``<noc>`` tag contains a single ``<topology>`` tag which describes the topology of the NoC.
+
+NoC topology
+~~~~~~~~~~~~
+
+As mentioned above the ``<topology>`` tag can be used to specify the topology or how the routers in the NoC
+are connected to each other. The ``<topology>`` tag consists of a group ``<router>``tags.
+
+Below is an example of how the ``<topology>`` tag is used.
+
+.. code-block:: xml
+
+    <topology>
+        <!--A number of <router> tags go here-->
+    </topology>
+
+The ``<router>`` tag and its contents are described below.
+
+.. arch:tag:: <router id="int" positionx="float" positiony="float" connections="int int int int ...">
+
+    This tag represents a single physical NoC router on the FPGA device and specifies how it is connected within the NoC.
+
+    :req_param  id:
+        Specifies a user identification (ID) number which is associate to the physical
+        router that this tag is identifying. This ID is used to report errors and
+        warnings to the user.
+    
+    :req_param positionx:
+        Specifies the horizontal position of the physical router block that this
+        tag is identifying. This position does not have to be exact, it can
+        be an approximate value.
+
+    :req_param positiony:
+        Specifies the vertical position of the physical router block that this
+        tag is identifying. This position does not have to be exact, it can
+        be an approximate value.
+
+    :req_param connections:
+        Specifies a list of numbers seperated by spaces which are the user IDs supplied to other
+        ``<router>`` tags. This describes how the current physical Noc router
+        that this tag is identifying is connected to the other physical NoC routers on the device.
+    
+    Below is an example of the ``<router>`` tag which identifies a physical router located near (0,0) with ID 0. This router
+    is also connected to two other routers identified by IDs 1 and 2.
+
+    .. code-block:: xml
+
+        <router id="0" positionx="0" positiony="0" connections="1 2"/>
+
+NoC Description Example
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Below is an example which describes a NoC architecture which has 4 physical routers that are connected to each other to form a 
+2x2 mesh topology.
+
+.. code-block:: xml
+    
+    <!-- Description of a 2x2 mesh NoC-->
+    <noc link_bandwidth="1.2e9" router_latency="1e-9" link_latency="1e-9" noc_router_tile_name="noc_router_adapter">
+        <topology>
+                <router id="0" positionx="0" positiony="0" connections="1 2"/>
+                <router id="1" positionx="5" positiony="0" connections="0 3"/>
+                <router id="2" positionx="0" positiony="5" connections="0 3"/>
+                <router id="3" positionx="5" positiony="5" connections="1 2"/>
+        </topology>
+    </noc>
+
 Wire Segments
 -------------