From d136ac236f6f831b4f0167e6023389d856085a1a Mon Sep 17 00:00:00 2001
From: tangxifan <tangxifan@gmail.com>
Date: Thu, 27 Feb 2020 19:39:57 -0700
Subject: [PATCH] adapt sdc memory utils

---
 openfpga/src/fpga_sdc/sdc_memory_utils.cpp | 69 ++++++++++++++++++++++
 openfpga/src/fpga_sdc/sdc_memory_utils.h   | 25 ++++++++
 2 files changed, 94 insertions(+)
 create mode 100644 openfpga/src/fpga_sdc/sdc_memory_utils.cpp
 create mode 100644 openfpga/src/fpga_sdc/sdc_memory_utils.h

diff --git a/openfpga/src/fpga_sdc/sdc_memory_utils.cpp b/openfpga/src/fpga_sdc/sdc_memory_utils.cpp
new file mode 100644
index 000000000..1910b4197
--- /dev/null
+++ b/openfpga/src/fpga_sdc/sdc_memory_utils.cpp
@@ -0,0 +1,69 @@
+/********************************************************************
+ * Most utilized function used to constrain memory cells in FPGA
+ * fabric using SDC commands
+ *******************************************************************/
+
+/* Headers from openfpgautil library */
+#include "openfpga_digest.h"
+
+#include "sdc_writer_utils.h"
+
+#include "sdc_memory_utils.h"
+
+/* begin namespace openfpga */
+namespace openfpga {
+
+/********************************************************************
+ * Print SDC commands to disable outputs of all the configurable memory modules
+ * in a given module 
+ * This function will be executed in a recursive way, 
+ * using a Depth-First Search (DFS) strategy
+ * It will iterate over all the configurable children under each module
+ * and print a SDC command to disable its outputs
+ *******************************************************************/
+void rec_print_pnr_sdc_disable_configurable_memory_module_output(std::fstream& fp, 
+                                                                 const ModuleManager& module_manager, 
+                                                                 const ModuleId& parent_module,
+                                                                 const std::string& parent_module_path) {
+
+  /* For each configurable child, we will go one level down in priority */
+  for (size_t child_index = 0; child_index < module_manager.configurable_children(parent_module).size(); ++child_index) {
+    std::string child_module_path = parent_module_path;
+    ModuleId child_module_id = module_manager.configurable_children(parent_module)[child_index];
+    size_t child_instance_id = module_manager.configurable_child_instances(parent_module)[child_index];
+    if (true == module_manager.instance_name(parent_module, child_module_id, child_instance_id).empty()) {
+      /* Give a default name <module_name>_<instance_id>_ */
+      child_module_path += module_manager.module_name(child_module_id); 
+      child_module_path += "_";
+      child_module_path += std::to_string(child_instance_id);
+      child_module_path += "_";
+    } else {
+      child_module_path += module_manager.instance_name(parent_module, child_module_id, child_instance_id);
+    }
+    child_module_path = format_dir_path(child_module_path);
+
+    rec_print_pnr_sdc_disable_configurable_memory_module_output(fp, module_manager, 
+                                                                child_module_id, 
+                                                                child_module_path);
+  }
+
+  /* If there is no configurable children any more, this is a leaf module, print a SDC command for disable timing */
+  if (0 < module_manager.configurable_children(parent_module).size()) {
+    return;
+  }
+
+  /* Validate file stream */
+  valid_file_stream(fp);
+
+  /* Disable timing for each output port of this module */
+  for (const BasicPort& output_port : module_manager.module_ports_by_type(parent_module, ModuleManager::MODULE_OUTPUT_PORT)) {
+    for (const size_t& pin : output_port.pins()) {
+      BasicPort output_pin(output_port.get_name(), pin, pin);
+      fp << "set_disable_timing ";
+      fp << parent_module_path << generate_sdc_port(output_pin);
+      fp << std::endl;
+    }
+  }
+}
+
+} /* end namespace openfpga */
diff --git a/openfpga/src/fpga_sdc/sdc_memory_utils.h b/openfpga/src/fpga_sdc/sdc_memory_utils.h
new file mode 100644
index 000000000..7fbf92294
--- /dev/null
+++ b/openfpga/src/fpga_sdc/sdc_memory_utils.h
@@ -0,0 +1,25 @@
+#ifndef SDC_MEMORY_UTILS_H
+#define SDC_MEMORY_UTILS_H
+
+/********************************************************************
+ * Include header files that are required by function declaration
+ *******************************************************************/
+#include <fstream>
+#include <string>
+#include "module_manager.h"
+
+/********************************************************************
+ * Function declaration
+ *******************************************************************/
+
+/* begin namespace openfpga */
+namespace openfpga {
+
+void rec_print_pnr_sdc_disable_configurable_memory_module_output(std::fstream& fp, 
+                                                                 const ModuleManager& module_manager, 
+                                                                 const ModuleId& parent_module,
+                                                                 const std::string& parent_module_path);
+
+} /* end namespace openfpga */
+
+#endif