Merge pull request #1184 from The-OpenROAD-Project-staging/asap7+macro_halo

Introduce MACRO_HALO_X and MACRO_HALO_Y

Author: maliberty

docs/user/FlowVariables.md

@@ -62,6 +62,8 @@ Note:
 | `PLACE_SITE`                         | =            | =            | =             | =         | =         |
 | `MAKE_TRACKS`                        | =            | =            | =             | =         | =         |
 | `TAPCELL_TCL`                        | =            | =            | =             | =         | =         |
+| `MACRO_HALO_X`                       | NA           | NA           | NA            | ?=        | NA        |
+| `MACRO_HALO_Y`                       | NA           | NA           | NA            | ?=        | NA        |
 | `MACRO_PLACE_HALO`                   | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `MACRO_PLACE_CHANNEL`                | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `PDN_TCL`                            | ?=           | ?=           | ?=            | ?=        | ?=        |
@@ -128,6 +130,7 @@ Note:
 | `PLACE_SITE`          | Placement site for core cells defined in the technology LEF file.                                                                                                                |
 | `TAPCELL_TCL`         | Path to Endcap and Welltie cells file.                                                                                                                                           |
 | `RTLMP_FLOW`          | Enable the Hierarchical RTLMP flow. By default it is disabled.                                                                                                                   |
+| `MACRO_HALO`          | Specifies keep out distance from macro, in X and Y, to standard cell row.                                                                                                        |
 | `MACRO_PLACEMENT`     | Specifies the path of a file on how to place certain macros manually using read_macro_placement.                                                                                 |
 | `MACRO_PLACEMENT_TCL` | Specifies the path of a TCL file on how to place certain macros manually.                                                                                                        |
 | `MACRO_PLACE_HALO`    | horizontal/vertical halo around macros (microns). Used by automatic macro placement.                                                                               |

flow/platforms/asap7/config.mk

@@ -84,8 +84,13 @@ export PDN_TCL ?= $(PLATFORM_DIR)/openRoad/pdn/grid_strategy-M1-M2-M5-M6.tcl
 export IO_PLACER_H             ?= M4
 export IO_PLACER_V             ?= M5
 
-export MACRO_PLACE_HALO ?= 10 10
-export MACRO_PLACE_CHANNEL ?= 12 12
+export MACRO_PLACE_HALO        ?= 10 10
+export MACRO_PLACE_CHANNEL     ?= 12 12
+
+# the followings create a keep out / halo between
+# macro and core rows
+export MACRO_HALO_X            ?= 2
+export MACRO_HALO_Y            ?= 2
 
 # Cell padding in SITE widths to ease rout-ability.  Applied to both sides
 export CELL_PAD_IN_SITES_GLOBAL_PLACEMENT ?= 2

flow/platforms/asap7/openRoad/tapcell.tcl

@@ -1,9 +1,13 @@
 puts "\[INFO-FLOW\] Tap and End Cap cell insertion"
 puts "\[INFO-FLOW\]   TAP Cell          : $::env(TAP_CELL_NAME)"
 puts "\[INFO-FLOW\]   ENDCAP Cell       : $::env(TAP_CELL_NAME)"
+puts "\[INFO-FLOW\]   Halo Around Macro : $::env(MACRO_HALO_X) $::env(MACRO_HALO_Y)"
 puts "\[INFO-FLOW\]   TAP Cell Distance : 25"
 
+# allow user to set the halo around macro with MACRO_HALO_?
 tapcell \
   -distance 25 \
   -tapcell_master "$::env(TAP_CELL_NAME)" \
-  -endcap_master "$::env(TAP_CELL_NAME)"
+  -endcap_master "$::env(TAP_CELL_NAME)"  \
+  -halo_width_x $::env(MACRO_HALO_X) \
+  -halo_width_y $::env(MACRO_HALO_X)