rename PRIMARY_SIGNOFF_TOOL to PRIMARY_GDSII_STREAMOUT_TOOL

The-OpenROAD-Project · Dec 6, 2023 · 44485b5 · 44485b5
1 parent 789097c
commit 44485b5
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 8 deletions.
diff --git a/configuration/general.tcl b/configuration/general.tcl
@@ -41,7 +41,7 @@ set ::env(RUN_IRDROP_REPORT) 1
 
 ## Signoff
 set ::env(RUN_CVC) 1
-set ::env(PRIMARY_SIGNOFF_TOOL) magic
+set ::env(PRIMARY_GDSII_STREAMOUT_TOOL) magic
 
 ### Netgen
 set ::env(RUN_LVS) 1

diff --git a/docs/source/reference/configuration.md b/docs/source/reference/configuration.md
@@ -321,7 +321,7 @@ These variables worked initially, but they were too sky130 specific and will be
 
 |Variable|Description|
 |-|-|
-| `PRIMARY_SIGNOFF_TOOL` <a id="PRIMARY_SIGNOFF_TOOL"></a> | Determines whether `magic` or `klayout` is the primary signoff tool. <br> (Default: `magic`) |
+| `PRIMARY_GDSII_STREAMOUT_TOOL` <a id="PRIMARY_GDSII_STREAMOUT_TOOL"></a> | Determines whether `magic` or `klayout` is the primary signoff tool. <br> (Default: `magic`) |
 | `USE_ARC_ANTENNA_CHECK` <a id="USE_ARC_ANTENNA_CHECK"></a> | Specifies whether to use the openroad ARC antenna checker or magic antenna checker. 0=magic antenna checker, 1=ARC OR antenna checker <br> (Default: `1`)
 | `RUN_CVC` <a id="RUN_CVC"></a> | Runs CVC on the output spice, which is a Circuit Validity Checker. Voltage aware ERC checker for CDL netlists. 1 = Enabled, 0 = Disabled. <br> (Default: `1`) |
 | `SIGNOFF_SDC_FILE` <a id="SIGNOFF_SDC_FILE"></a> | Specifies SDC file used by multicorner STA during signoff stage, which can be different from the one used for implementation. <br> (Default: `BASE_SDC_FILE`) |
@@ -330,7 +330,7 @@ These variables worked initially, but they were too sky130 specific and will be
 |Variable|Description|
 |-|-|
 | `RUN_MAGIC` <a id="RUN_MAGIC"></a> | Enables running magic and GDSII streaming. 1 = Enabled, 0 = Disabled <br> (Default: `1`)|
-| `RUN_MAGIC_DRC` <a id="RUN_MAGIC_DRC"></a> | Enables running magic DRC on GDSII produced by magic. 1 = Enabled, 0 = Disabled <br> (Default: `1`)|
+| `RUN_MAGIC_DRC` <a id="RUN_MAGIC_DRC"></a> | Enables running magic DRC on either GDSII produced by `PRIMARY_GDSII_STREAMOUT_TOOL` or final produced DEF file depending on `MAGIC_DRC_USE_GDS`. 1 = Enabled, 0 = Disabled <br> (Default: `1`)|
 | `MAGIC_PAD` <a id="MAGIC_PAD"></a> |  A flag to pad the views generated by magic (.mag, .lef, .gds) with one site. 1 = Enabled, 0 = Disabled <br> (Default: `0`)|
 | `MAGIC_ZEROIZE_ORIGIN` <a id="MAGIC_ZEROIZE_ORIGIN"></a> | A flag to move the layout such that it's origin in the lef generated by magic is 0,0. 1 = Enabled, 0 = Disabled  <br> (Default: `1`)|
 | `MAGIC_GENERATE_GDS` <a id="MAGIC_GENERATE_GDS"></a> | A flag to generate gds view via magic. 1 = Enabled, 0 = Disabled  <br> (Default: `1`)|
@@ -355,7 +355,7 @@ These variables worked initially, but they were too sky130 specific and will be
 |-|-|
 | `RUN_KLAYOUT` <a id="RUN_KLAYOUT"></a> | Enables running KLayout and GDSII streaming. 1 = Enabled, 0 = Disabled <br> (Default: `1`)|
 | `RUN_KLAYOUT_XOR` <a id="RUN_KLAYOUT_XOR"></a> | Enables running KLayout XOR on 2 GDSIIs, the defaults are the one produced by magic vs the one produced by klayout. 1 = Enabled, 0 = Disabled <br> (Default: `1`)|
-| `RUN_KLAYOUT_DRC` <a id="RUN_KLAYOUT_DRC"></a> | Enables running KLayout DRC on GDSII produced by magic. 1 = Enabled, 0 = Disabled <br> (Default: `0`)|
+| `RUN_KLAYOUT_DRC` <a id="RUN_KLAYOUT_DRC"></a> | Enables running KLayout DRC on GDSII produced by `PRIMARY_GDSII_STREAMOUT_TOOL`. 1 = Enabled, 0 = Disabled <br> (Default: `0`)|
 | `KLAYOUT_DRC_KLAYOUT_GDS` <a id="KLAYOUT_DRC_KLAYOUT_GDS"></a> | Enables running KLayout DRC on GDSII produced by KLayout. 1 = Enabled, 0 = Disabled <br> (Default: `0`)|
 | `KLAYOUT_XOR_THREADS` <a id="KLAYOUT_XOR_THREADS"></a> | Specifies number of threads used in klayout xor check <br> (Default: `1`)|
 | `KLAYOUT_DRC_THREADS` <a id="KLAYOUT_DRC_THREADS"></a> | Specifies number of threads used in klayout drc check <br> (Default: `1`)|

diff --git a/scripts/tcl_commands/all.tcl b/scripts/tcl_commands/all.tcl
@@ -638,6 +638,7 @@ proc prep {args} {
     handle_deprecated_config UNBUFFER_NETS RSZ_DONT_TOUCH_RX
 
     handle_deprecated_config RCX_SDC_FILE SIGNOFF_SDC_FILE
+    handle_deprecated_config PRIMARY_SIGNOFF_TOOL PRIMARY_GDSII_STREAMOUT_TOOL
 
     ### Checkers/Quitting
     handle_deprecated_config CHECK_ASSIGN_STATEMENTS QUIT_ON_ASSIGN_STATEMENTS

diff --git a/scripts/tcl_commands/klayout.tcl b/scripts/tcl_commands/klayout.tcl
@@ -52,15 +52,15 @@ proc run_klayout {args} {
 		}
 
 
-		if { $::env(PRIMARY_SIGNOFF_TOOL) == "klayout" } {
+		if { $::env(PRIMARY_GDSII_STREAMOUT_TOOL) == "klayout" } {
 			set ::env(CURRENT_GDS) $::env(signoff_results)/$::env(DESIGN_NAME).gds
 			file copy -force $klayout_out $::env(CURRENT_GDS)
 		}
 
 		TIMER::timer_stop
 		exec echo "[TIMER::get_runtime]" | python3 $::env(SCRIPTS_DIR)/write_runtime.py "gdsii - klayout"
 		scrot_klayout -layout $::env(signoff_results)/$::env(DESIGN_NAME).gds -log $::env(signoff_logs)/screenshot.klayout.log
-	} elseif { $::env(PRIMARY_SIGNOFF_TOOL) != "klayout" } {
+	} elseif { $::env(PRIMARY_GDSII_STREAMOUT_TOOL) != "klayout" } {
 		puts_warn "::env(KLAYOUT_TECH) is not defined for the current PDK. So, GDSII streaming out using KLayout will be skipped."
 		puts_warn "This warning can be turned off by setting ::env(RUN_KLAYOUT) to 0, or defining a tech file."
 	} else {
@@ -154,7 +154,7 @@ proc scrot_klayout {args} {
 			puts_info "Screenshot taken."
 			TIMER::timer_stop
 			exec echo "[TIMER::get_runtime]" | python3 $::env(SCRIPTS_DIR)/write_runtime.py "screenshot - klayout"
-		} elseif { $::env(PRIMARY_SIGNOFF_TOOL) != "klayout" } {
+		} elseif { $::env(PRIMARY_GDSII_STREAMOUT_TOOL) != "klayout" } {
 			puts_warn "::env(KLAYOUT_DRC_TECH_SCRIPT) is not defined for the current PDK. So, GDSII streaming out using KLayout will be skipped."
 			puts_warn "This warning can be turned off by setting ::env(RUN_KLAYOUT_DRC) to 0, or designating a tech file."
 		} else {

diff --git a/scripts/tcl_commands/magic.tcl b/scripts/tcl_commands/magic.tcl
@@ -32,7 +32,7 @@ proc run_magic {args} {
         -indexed_log $log\
         $::env(SCRIPTS_DIR)/magic/def/mag_gds.tcl
 
-    if { $::env(PRIMARY_SIGNOFF_TOOL) == "magic" } {
+    if { $::env(PRIMARY_GDSII_STREAMOUT_TOOL) == "magic" } {
         set ::env(CURRENT_GDS) $::env(signoff_results)/$::env(DESIGN_NAME).gds
         file copy -force $::env(MAGIC_GDS) $::env(CURRENT_GDS)
     }