mpl: keep old keys for compatibility and add deprecated warning

Signed-off-by: Arthur Koucher <arthurkoucher@precisioninno.com>

Author: AcKoucher

src/mpl/README.md

@@ -26,6 +26,8 @@ rtl_macro_placer
     [-max_num_level max_num_level] 
     [-coarsening_ratio coarsening_ratio]
     [-large_net_threshold large_net_threshold]
+    [-halo_width halo_width]
+    [-halo_height halo_height]
     [-fence_lx fence_lx] 
     [-fence_ly fence_ly]
     [-fence_ux fence_ux]
@@ -55,6 +57,8 @@ rtl_macro_placer
 | `-max_num_level` | Maximum depth of physical hierarchical tree. The default value is `2`, and the allowed values are integers `[0, MAX_INT]`. |
 | `-coarsening_ratio` | The larger the coarsening_ratio, the faster the convergence process. The allowed values are floats, and the default value is `10.0`. |
 | `-large_net_threshold` | Ignore nets with many connections during clustering, such as global nets. The default value is `50`, and the allowed values are integers `[0, MAX_INT]`. |
+| `-halo_width` | **Deprecated: use `set_macro_default_halo` instead.** Horizontal halo around macros (microns). The default value is `0.0`. |
+| `-halo_height` | **Deprecated: use `set_macro_default_halo` instead.** Vertical halo around macros (microns). The default value is `0.0`. |
 | `-fence_lx`, `-fence_ly`, `-fence_ux`, `-fence_uy` | Defines the global fence bounding box coordinates. The default values are the core area coordinates). |
 | `-target_util` | Specifies the target utilization. The allowed values are floats and the default value is `0.25`. |
 | `-min_ar` | Specifies the minimum aspect ratio $a$, or the ratio of its width to height of a `StandardCellCluster` from $[a, \frac{1}{a}]$. The allowed values are floats, and the default value is `0.33`. |

src/mpl/src/mpl.tcl

@@ -9,6 +9,8 @@ sta::define_cmd_args "rtl_macro_placer" { -max_num_macro  max_num_macro \
                                           -max_num_level  max_num_level \
                                           -coarsening_ratio coarsening_ratio \
                                           -large_net_threshold large_net_threshold \
+                                          -halo_width halo_width \
+                                          -halo_height halo_height \
                                           -fence_lx   fence_lx \
                                           -fence_ly   fence_ly \
                                           -fence_ux   fence_ux \
@@ -32,6 +34,7 @@ proc rtl_macro_placer { args } {
   sta::parse_key_args "rtl_macro_placer" args \
     keys {-max_num_macro  -min_num_macro -max_num_inst  -min_num_inst  -tolerance   \
          -max_num_level  -coarsening_ratio -large_net_threshold \
+         -halo_width -halo_height \
          -fence_lx   -fence_ly  -fence_ux   -fence_uy  \
          -area_weight  -outline_weight -wirelength_weight -guidance_weight -fence_weight \
          -boundary_weight -notch_weight \
@@ -104,6 +107,27 @@ proc rtl_macro_placer { args } {
     set large_net_threshold $keys(-large_net_threshold)
   }
 
+  if { [info exists keys(-halo_width)] || [info exists keys(-halo_height)] } {
+    utl::warn MPL 74 "-halo_width/-halo_height are deprecated, use\
+                      the set_macro_default_halo command instead."
+    set halo_width 0.0
+    set halo_height 0.0
+
+    if { [info exists keys(-halo_width)] } {
+      set halo_width $keys(-halo_width)
+      set halo_height $halo_width
+    }
+
+    if { [info exists keys(-halo_height)] } {
+      set halo_height $keys(-halo_height)
+      if { ![info exists keys(-halo_width)] } {
+        set halo_width $halo_height
+      }
+    }
+
+    mpl::set_default_halo $halo_width $halo_height $halo_width $halo_height
+  }
+
   if { [info exists keys(-fence_lx)] } {
     set fence_lx $keys(-fence_lx)
   }