Added PLATFORM_TCL support to optionally load a Tcl script called before load_design

Signed-off-by: Jeff Ng <[email protected]>

Author: jeffng-or

docs/user/FlowVariables.md

@@ -133,6 +133,7 @@ configuration file.
 | <a name="PLACE_PINS_ARGS"></a>PLACE_PINS_ARGS| Arguments to place_pins| | |
 | <a name="PLACE_SITE"></a>PLACE_SITE| Placement site for core cells defined in the technology LEF file.| | |
 | <a name="PLATFORM"></a>PLATFORM| Specifies process design kit or technology node to be used.| | |
+| <a name="PLATFORM_TCL"></a>PLATFORM_TCL| Specifies a Tcl script with commands to run before loading design.| | |
 | <a name="POST_CTS_TCL"></a>POST_CTS_TCL| Specifies a Tcl script with commands to run after CTS is completed.| | |
 | <a name="PROCESS"></a>PROCESS| Technology node or process in use.| | |
 | <a name="PWR_NETS_VOLTAGES"></a>PWR_NETS_VOLTAGES| Used for IR Drop calculation.| | |
@@ -413,6 +414,7 @@ configuration file.
 - [LIB_FILES](#LIB_FILES)
 - [MACRO_EXTENSION](#MACRO_EXTENSION)
 - [PLATFORM](#PLATFORM)
+- [PLATFORM_TCL](#PLATFORM_TCL)
 - [PROCESS](#PROCESS)
 - [RCX_RULES](#RCX_RULES)
 - [RECOVER_POWER](#RECOVER_POWER)

flow/platforms/asap7/config.mk

@@ -7,6 +7,8 @@ ifeq ($(LIB_MODEL),)
 endif
 export LIB_DIR                ?= $(PLATFORM_DIR)/lib/$(LIB_MODEL)
 
+export PLATFORM_TCL            = $(PLATFORM_DIR)/liberty_suppressions.tcl
+
 #Library Setup variable
 export TECH_LEF                = $(PLATFORM_DIR)/lef/asap7_tech_1x_201209.lef
 

flow/platforms/asap7/liberty_suppressions.tcl

@@ -0,0 +1,4 @@
+# To remove [WARNING STA-1212] from the logs for ASAP7.
+# /OpenROAD-flow-scripts/flow/platforms/asap7/lib/asap7sc7p5t_SIMPLE_RVT_TT_nldm_211120.lib.gz line 13178, timing group from output port.
+# Added following suppress_message
+log_cmd suppress_message STA 1212

flow/scripts/load.tcl

@@ -3,29 +3,35 @@ source $::env(SCRIPTS_DIR)/util.tcl
 source $::env(SCRIPTS_DIR)/report_metrics.tcl
 
 proc load_design {design_file sdc_file} {
+  # Source platform-related Tcl command (initially for suppressing Liberty
+  # warnings
+  if {[env_var_exists_and_non_empty PLATFORM_TCL]} {
+    log_cmd source $::env(PLATFORM_TCL)
+  }
+  
   # Read liberty files
-  source $::env(SCRIPTS_DIR)/read_liberty.tcl
+  log_cmd source $::env(SCRIPTS_DIR)/read_liberty.tcl
 
   # Read design files
   set ext [file extension $design_file]
   if {$ext == ".v"} {
-    read_lef $::env(TECH_LEF)
-    read_lef $::env(SC_LEF)
+    log_cmd read_lef $::env(TECH_LEF)
+    log_cmd read_lef $::env(SC_LEF)
     if {[env_var_exists_and_non_empty ADDITIONAL_LEFS]} {
       foreach lef $::env(ADDITIONAL_LEFS) {
-        read_lef $lef
+        log_cmd read_lef $lef
       }
     }
-    read_verilog $::env(RESULTS_DIR)/$design_file
-    link_design $::env(DESIGN_NAME)
+    log_cmd read_verilog $::env(RESULTS_DIR)/$design_file
+    log_cmd link_design $::env(DESIGN_NAME)
   } elseif {$ext == ".odb"} {
-    read_db $::env(RESULTS_DIR)/$design_file
+    log_cmd read_db $::env(RESULTS_DIR)/$design_file
   } else {
     error "Unrecognized input file $design_file"
   }
 
   # Read SDC file
-  read_sdc $::env(RESULTS_DIR)/$sdc_file
+  log_cmd read_sdc $::env(RESULTS_DIR)/$sdc_file
 
   if [file exists $::env(PLATFORM_DIR)/derate.tcl] {
     log_cmd source $::env(PLATFORM_DIR)/derate.tcl

flow/scripts/read_liberty.tcl

@@ -1,29 +1,18 @@
-# To remove [WARNING STA-1212] from the logs for ASAP7.
-# /OpenROAD-flow-scripts/flow/platforms/asap7/lib/asap7sc7p5t_SIMPLE_RVT_TT_nldm_211120.lib.gz line 13178, timing group from output port.
-# Added following suppress_message
-if {[env_var_equals PLATFORM asap7]} {
-   suppress_message STA 1212
-}
-
 #Read Liberty
 if {[env_var_exists_and_non_empty CORNERS]} {
   # corners
-  define_corners {*}$::env(CORNERS)
+  log_cmd define_corners {*}$::env(CORNERS)
   foreach corner $::env(CORNERS) {
     set LIBKEY "[string toupper $corner]_LIB_FILES"
     foreach libFile $::env($LIBKEY) {
-    read_liberty -corner $corner $libFile
+      log_cmd read_liberty -corner $corner $libFile
     }
     unset LIBKEY
   }
   unset corner
 } else {
   ## no corner
   foreach libFile $::env(LIB_FILES) {
-    read_liberty $libFile
+    log_cmd read_liberty $libFile
   }
 }
-
-if {[env_var_equals PLATFORM asap7]} {
-   unsuppress_message STA 1212
-}

flow/scripts/variables.yaml

@@ -146,6 +146,9 @@ LIB_FILES:
     A Liberty file of the standard cell library with PVT characterization,
     input and output characteristics, timing and power definitions for each
     cell.
+PLATFORM_TCL:
+  description: |
+    Specifies a Tcl script with commands to run before loading design.
 DONT_USE_CELLS:
   description: |
     Dont use cells eases pin access in detailed routing.