finishing: refactor shell script

Author: thommythomaso

ihp13/init.sh

@@ -6,39 +6,53 @@
 #
 # - Thomas Benz  <tbenz@iis.ee.ethz.ch>
 
-# klayout batch mode to create the sealring and fill
+# KLayout batch mode to create the sealring and metal fill
+
+set -e  # Exit on error
+set -u  # Error on undefined vars
+
+
+################
+### Setup
+################
 
 export KLAYOUT=${KLAYOUT:-klayout}
 
-root_dir=$(realpath $(dirname "${BASH_SOURCE[0]}")/../..)
+root_dir=$(realpath $(dirname "${BASH_SOURCE[0]}")/..)
 klayout_dir=${root_dir}/ihp13/pdk/ihp-sg13g2/libs.tech/klayout
 export KLAYOUT_PATH=$klayout_dir
 export PDK=ihp-sg13g2
 export PDK_ROOT=${root_dir}/ihp13/pdk
 
-echo "Root: ${root_dir}"
-echo "KLayout: ${klayout_dir}"
-
+echo "[INFO] Root: ${root_dir}"
+echo "[INFO] KLayout: ${klayout_dir}"
 
-###############
-### Filler  ###
-###############
-FILLER=false
+# Apply PDK patches required for filling
+if [ ! -f ${root_dir}/ihp13/pdk.patched ]; then
+    git -C ${PDK_ROOT} apply ../patches/0001-Filling-improvements.patch
+    touch ${root_dir}/ihp13/pdk.patched
+    echo "[INFO] Applied all PDK patches"
+else
+    echo "[INFO] PDK patches already applied"
+fi
 
 
 #############
 ### Help  ###
 #############
+
 show_help() {
   cat <<EOF
 Usage: $(basename "$0") [OPTIONS]
 
 Options:
-  -f, --filler     Enable filler mode
+  --no-stream      Skip producing stream from LEF/DEF
+  --no-seal        Skip seal ring
+  --filling        Enable activ and metal filling
   -h, --help       Show this help message and exit
 
 Examples:
-  $(basename "$0") --filler
+  $(basename "$0") --filling
   $(basename "$0") -f
 EOF
 }
@@ -47,9 +61,22 @@ EOF
 ########################
 ### Parse Arguments  ###
 ########################
+
+STREAM=true
+SEAL=true
+FILLER=false
+
 while [[ $# -gt 0 ]]; do
   case "$1" in
-    -f|--filler)
+    --no-stream)
+      STREAM=false
+      shift
+      ;;
+    --no-seal)
+      SEAL=false
+      shift
+      ;;
+    --filling)
       FILLER=true
       shift
       ;;
@@ -70,6 +97,7 @@ done
 ################
 ### Project  ###
 ################
+
 top_design=${TOP_DESIGN:-"croc_chip"}
 def_file=${DEF_FILE:-"$root_dir/openroad/out/croc.def"}
 out_file=${OUT_FILE:-"$root_dir/klayout/out/$top_design.gds.gz"}
@@ -87,13 +115,14 @@ die_um=($(grep DIEAREA ${def_file} | grep -oE '[0-9]+' | tail -n 2 | xargs))
 die_width=$(( ${die_um[-2]} / 1000 ))
 die_height=$(( ${die_um[-1]} / 1000 ))
 
-echo "Read ${def_file} - die area is ${die_width} um x ${die_height} um"
+echo "[INFO] Read ${def_file} - die area is ${die_width} um x ${die_height} um"
 
 
 ################
 ## Technology ##
 ################
-if [[ -d "$root_dir/technology" ]]; then
+
+if [[ -d "[INFO]  $root_dir/technology" ]]; then
     echo "Init tech from ETHZ DZ cockpit"
     pdk_dir=$(realpath "$root_dir/technology")
     pdk_cells_lef_dir="${pdk_dir}/lef"
@@ -103,7 +132,7 @@ if [[ -d "$root_dir/technology" ]]; then
     pdk_sram_gds_dir="${pdk_dir}/gds"
     pdk_io_gds_dir="${pdk_dir}/gds"
 else
-    echo "Init tech from Github PDK"
+    echo "[INFO] Init tech from Github PDK"
     pdk_dir=${pdk_dir:-$(realpath "$root_dir/ihp13/pdk/ihp-sg13g2")}
     pdk_cells_lef_dir="${pdk_dir}/libs.ref/sg13g2_stdcell/lef"
     pdk_sram_lef_dir="${pdk_dir}/libs.ref/sg13g2_sram/lef"
@@ -131,6 +160,7 @@ gds="$(find "$pdk_cells_gds_dir" -name 'sg13g2_stdcell.gds' -exec realpath {} \;
 ################
 ## Def2Stream ##
 ################
+
 klayout_cmd="$KLAYOUT -zz \
           -rd gds_allow_empty="True" \
           -rd design_name=\"$top_design\" \
@@ -141,9 +171,14 @@ klayout_cmd="$KLAYOUT -zz \
           -rd out_file=\"$out_file\" \
           -rm scripts/def2stream.py"
 
-echo $klayout_cmd
-eval $klayout_cmd
-
+if [[ "$STREAM" == true ]]; then
+  echo "[INFO] Running LEF/DEF to stream"
+  echo $klayout_cmd
+  echo ""
+  eval $klayout_cmd
+else
+  echo "[INFO] Skipping LEF/DEF to stream"
+fi
 
 #################
 ### Seal Gen  ###
@@ -154,8 +189,14 @@ sealring_gen_cmd="$KLAYOUT -n sg13g2 -zz \
                            -rd height=$((  $die_width + 2 * $sealringspace )) \
                            -rd output=$seal_file"
 
-echo $sealring_gen_cmd
-eval $sealring_gen_cmd
+if [[ "$SEAL" == true ]]; then
+  echo "[INFO] Creating seal ring"
+  echo $sealring_gen_cmd
+  echo ""
+  eval $sealring_gen_cmd
+else
+  echo "[INFO] Skipping seal ring creation"
+fi
 
 
 ###################
@@ -167,12 +208,17 @@ sealring_merge_cmd="$KLAYOUT -zz \
                              -rd seal_gds=$seal_file \
                              -rd dx_um=$sealringspace \
                              -rd dy_um=$sealringspace \
-                             -rd top_name=${chipname}_w_sealring \
+                             -rd top_name=${top_design}_w_sealring \
                              -rd out_gds=$sealed_file"
 
-echo $sealring_merge_cmd
-eval $sealring_merge_cmd
-
+if [[ "$SEAL" == true ]]; then
+  echo "[INFO] Merging seal ring"
+  echo $sealring_merge_cmd
+  echo ""
+  eval $sealring_merge_cmd
+else
+  echo "[INFO] Skipping seal ring merging"
+fi
 
 #######################
 ### Density Filling ###
@@ -183,7 +229,12 @@ fill_cmd="$KLAYOUT -n sg13g2 -zz \
         -rd no_topmetal_2 \
         $sealed_file"
 
-echo $fill_cmd
+
 if [[ "$FILLER" == true ]]; then
-    eval $fill_cmd
+  echo "[INFO] Activ and metal filling"
+  echo $fill_cmd
+  echo ""
+  eval $fill_cmd
+else
+  echo "[INFO] Skipping activ and metal filling"
 fi