From 0eebdaf942ca5bde2626101539ec30aef6130c1e Mon Sep 17 00:00:00 2001
From: tangxifan <tangxifan@gmail.com>
Date: Tue, 24 Dec 2019 15:07:03 -0700
Subject: [PATCH] add grid port naming function for modules

---
 .../vpr/SRC/fpga_x2p/base/fpga_x2p_naming.cpp | 47 +++++++++++++++++--
 .../vpr/SRC/fpga_x2p/base/fpga_x2p_naming.h   |  9 ++++
 2 files changed, 53 insertions(+), 3 deletions(-)

diff --git a/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.cpp b/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.cpp
index abf4a7a7e..8b3577ba1 100644
--- a/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.cpp
+++ b/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.cpp
@@ -384,9 +384,9 @@ std::string generate_connection_block_module_name(const t_rr_type& cb_type,
 }
 
 /*********************************************************************
- * Generate the port name for a Grid
- * TODO: add more comments about why we need different names for 
- * top and non-top netlists
+ * Generate the port name for a grid in top-level netlists, i.e., full FPGA fabric
+ * This function will generate a full port name including coordinates
+ * so that each pin in top-level netlists is unique!
  *********************************************************************/
 std::string generate_grid_port_name(const vtr::Point<size_t>& coordinate,
                                     const size_t& height, 
@@ -419,6 +419,26 @@ std::string generate_grid_port_name(const vtr::Point<size_t>& coordinate,
   return port_name;
 }
 
+/*********************************************************************
+ * Generate the port name for a grid in the context of a module
+ * To keep a short and simple name, this function will not 
+ * include any grid coorindate information!
+ *********************************************************************/
+std::string generate_grid_module_port_name(const size_t& height, 
+                                           const e_side& side, 
+                                           const size_t& pin_id) {
+  /* For non-top netlist */
+  Side side_manager(side);
+  std::string port_name = std::string("grid_");
+  port_name += std::string(side_manager.to_string());
+  port_name += std::string("_height_");
+  port_name += std::to_string(height);
+  port_name += std::string("__pin_");
+  port_name += std::to_string(pin_id);
+  port_name += std::string("_");
+  return port_name;
+}
+
 /*********************************************************************
  * Generate the port name for a Grid
  * This is a wrapper function for generate_port_name()
@@ -441,6 +461,27 @@ std::string generate_grid_side_port_name(const std::vector<std::vector<t_grid_ti
   return generate_grid_port_name(coordinate, height, side, pin_id, true);
 }
 
+/*********************************************************************
+ * Generate the port name of a grid pin for a routing module,
+ * which could be a switch block or a connection block
+ *********************************************************************/
+std::string generate_routing_module_grid_port_name(const std::vector<std::vector<t_grid_tile>>& grids,
+                                                   const vtr::Point<size_t>& coordinate,
+                                                   const e_side& side, 
+                                                   const size_t& pin_id) {
+  /* Output the pins on the side*/ 
+  size_t height = find_grid_pin_height(grids, coordinate, pin_id);
+  if (1 != grids[coordinate.x()][coordinate.y()].type->pinloc[height][side][pin_id]) {
+    Side side_manager(side);
+    vpr_printf(TIO_MESSAGE_ERROR, 
+               "(File:%s, [LINE%d])Fail to generate a grid pin (x=%lu, y=%lu, height=%lu, side=%s, index=%d)\n",
+               __FILE__, __LINE__, 
+               coordinate.x(), coordinate.y(), height, side_manager.c_str(), pin_id);
+    exit(1);
+  } 
+  return generate_grid_module_port_name(height, side, pin_id);
+}
+
 /*********************************************************************
  * Generate the port name for a reserved sram port, i.e., BLB/WL port
  * When port_type is BLB, a string denoting to the reserved BLB port is generated
diff --git a/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.h b/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.h
index 3508792d4..d83efcad2 100644
--- a/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.h
+++ b/vpr7_x2p/vpr/SRC/fpga_x2p/base/fpga_x2p_naming.h
@@ -116,11 +116,20 @@ std::string generate_grid_port_name(const vtr::Point<size_t>& coordinate,
                                     const size_t& pin_id,
                                     const bool& for_top_netlist);
 
+std::string generate_grid_module_port_name(const size_t& height, 
+                                           const e_side& side, 
+                                           const size_t& pin_id);
+
 std::string generate_grid_side_port_name(const std::vector<std::vector<t_grid_tile>>& grids,
                                          const vtr::Point<size_t>& coordinate,
                                          const e_side& side, 
                                          const size_t& pin_id);
 
+std::string generate_routing_module_grid_port_name(const std::vector<std::vector<t_grid_tile>>& grids,
+                                                   const vtr::Point<size_t>& coordinate,
+                                                   const e_side& side, 
+                                                   const size_t& pin_id);
+
 std::string generate_reserved_sram_port_name(const e_spice_model_port_type& port_type);
 
 std::string generate_formal_verification_sram_port_name(const CircuitLibrary& circuit_lib,