From 37241af1fca7be9dec04be37f8d477e7bcd91003 Mon Sep 17 00:00:00 2001
From: Jerry Zhao <jerryz123@berkeley.edu>
Date: Tue, 4 Jun 2019 10:36:25 -0700
Subject: [PATCH] Add initial VLSI flow scripts

---
 .gitmodules       |   4 ++
 vlsi/.gitignore   |   6 +++
 vlsi/Makefile     | 122 ++++++++++++++++++++++++++++++++++++++++++++++
 vlsi/README.md    |   5 ++
 vlsi/example-vlsi |  36 ++++++++++++++
 vlsi/hammer       |   1 +
 6 files changed, 174 insertions(+)
 create mode 100644 vlsi/.gitignore
 create mode 100644 vlsi/Makefile
 create mode 100644 vlsi/README.md
 create mode 100755 vlsi/example-vlsi
 create mode 160000 vlsi/hammer

diff --git a/.gitmodules b/.gitmodules
index ca80d66..9e30fb3 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -40,3 +40,7 @@
 [submodule "generators/block-inclusivecache-sifive"]
 	path = generators/sifive-cache
 	url = https://github.com/sifive/block-inclusivecache-sifive.git
+[submodule "vlsi/hammer"]
+	path = vlsi/hammer
+	url = git@github.com:ucb-bar/hammer.git
+
diff --git a/vlsi/.gitignore b/vlsi/.gitignore
new file mode 100644
index 0000000..4cbcfe8
--- /dev/null
+++ b/vlsi/.gitignore
@@ -0,0 +1,6 @@
+inputs.yml
+__pycache__
+hammer*.log
+build
+src/test/output-*.json
+generated-src
\ No newline at end of file
diff --git a/vlsi/Makefile b/vlsi/Makefile
new file mode 100644
index 0000000..5b6390b
--- /dev/null
+++ b/vlsi/Makefile
@@ -0,0 +1,122 @@
+#########################################################################################
+# vlsi makefile
+#########################################################################################
+
+#########################################################################################
+# general path variables
+#########################################################################################
+base_dir=$(abspath ..)
+vlsi_dir=$(abspath .)
+sim_dir=$(abspath .)
+
+#########################################################################################
+# include shared variables
+#########################################################################################
+include $(base_dir)/variables.mk
+
+#########################################################################################
+# import other necessary rules and variables
+#########################################################################################
+include $(base_dir)/common.mk
+
+#########################################################################################
+# vlsi types and rules
+#########################################################################################
+
+#sim_name is unused, but GenerateSimFiles expects it
+sim_name     ?= vcs
+tech_name    ?= 
+tech_dir     ?= $(vlsi_dir)/hammer-$(tech_nam)-plugin/$(tech_name)
+SMEMS_COMP   ?= $(tech_dir)/sram-compiler.json
+SMEMS_HAMMER ?= $(build_dir)/$(long_name).mems.hammer.json
+MACROCOMPILER_MODE ?= -l $(SMEMS_COMP) --use-compiler -hir $(SMEMS_HAMMER)
+OBJ_DIR      ?= $(vlsi_dir)/build
+ENV_YML      ?= $(vlsi_dir)/hammer-cad-plugins/bwrc-env.yml
+INPUT_CONFS  ?= example.yml $(dir $(tech_dir))/bwrc.yml
+HAMMER_EXEC  ?= ./example-vlsi
+
+ROCKET_SRC_DIR=$(ROCKETCHIP_DIR)/src/main/resources/vsrc
+
+ROCKET_SRCS = \
+	$(ROCKET_SRC_DIR)/ClockDivider2.v \
+	$(ROCKET_SRC_DIR)/ClockDivider3.v \
+	$(ROCKET_SRC_DIR)/AsyncResetReg.v \
+	$(ROCKET_SRC_DIR)/plusarg_reader.v \
+	$(ROCKET_SRC_DIR)/EICG_wrapper.v \
+
+ALL_RTL = $(ROCKET_SRCS) $(VERILOG_FILE) $(SMEMS_FILE)
+
+CLOCK_DOMAINS = $(build_dir)/$(long_name).domains
+
+.PHONY: default
+default: all
+
+all: drc lvs
+
+
+###################################################### SYN ############################################################
+
+SYNTH_CONF = $(OBJ_DIR)/inputs.yml
+
+$(SYNTH_CONF):
+	mkdir -p $(dir $@)
+	echo "synthesis.inputs:" > $@
+	echo "  top_module: $(TOP)" >> $@
+	echo "  input_files:" >> $@
+	for x in $(ALL_RTL); do \
+		echo '    - "'$$x'"' >> $@; \
+	done
+
+GENERATED_CONFS=$(SYNTH_CONF) $(SRAM_CONF)
+
+.PHONY: syn synthesis
+syn: $(OBJ_DIR)/syn-rundir/$(TOP).mapped.v
+synthesis: syn
+
+$(OBJ_DIR)/syn-rundir/$(TOP).mapped.v $(OBJ_DIR)/syn-rundir/syn-output.json: $(ENV_YML) $(INPUT_CONFS) $(GENERATED_CONFS) $(ALL_RTL)
+	mkdir -p $(dir $@)
+	$(HAMMER_EXEC) -e $(ENV_YML) $(foreach x,$(INPUT_CONFS) $(GENERATED_CONFS), -p $(x)) --obj_dir $(OBJ_DIR) syn
+
+$(OBJ_DIR)/par-input.json: $(OBJ_DIR)/syn-rundir/syn-output.json
+	mkdir -p $(dir $@)
+	$(HAMMER_EXEC) -e $(ENV_YML) $(foreach x,$(INPUT_CONFS) $<, -p $(x)) -o $@ syn_to_par
+
+###################################################### PAR ############################################################
+
+.PHONY: par place-and-route
+par: $(OBJ_DIR)/par-rundir/$(TOP).gds
+place-and-route: par
+
+$(OBJ_DIR)/par-rundir/$(TOP).gds $(OBJ_DIR)/par-rundir/par-output.json: $(OBJ_DIR)/par-input.json $(OBJ_DIR)/syn-rundir/$(TOP).mapped.v
+	mkdir -p $(dir $@)
+	$(HAMMER_EXEC) -e $(ENV_YML) -p $< --obj_dir $(OBJ_DIR) par
+
+$(OBJ_DIR)/drc-input.json: $(OBJ_DIR)/par-input.json $(OBJ_DIR)/par-rundir/par-output.json
+	mkdir -p $(dir $@)
+	$(HAMMER_EXEC) -e $(ENV_YML) $(foreach x,$^, -p $(x)) -o $@ --obj_dir $(OBJ_DIR) par_to_drc
+
+###################################################### DRC ############################################################
+# TODO unimplemented
+.PHONY: drc
+drc: $(OBJ_DIR)/drc-rundir/drc_results.db
+
+$(OBJ_DIR)/drc-rundir/drc_results.db: $(OBJ_DIR)/drc-input.json $(OBJ_DIR)/par-rundir/$(TOP).gds
+	mkdir -p $(dir $@)
+	$(HAMMER_EXEC) -e $(ENV_YML) -p $< --obj_dir $(OBJ_DIR) drc
+
+###################################################### LVS ############################################################
+# TODO unimplemented
+$(OBJ_DIR)/lvs-input.json: $(OBJ_DIR)/par-input.json $(OBJ_DIR)/par-rundir/par-output.json
+	mkdir -p $(dir $@)
+	$(HAMMER_EXEC) -e $(ENV_YML) $(foreach x,$^, -p $(x)) -o $@ --obj_dir $(OBJ_DIR) par_to_lvs
+
+.PHONY: lvs
+lvs: $(OBJ_DIR)/lvs-rundir/lvs_results.rpt
+
+$(OBJ_DIR)/lvs-rundir/lvs_results.rpt: $(OBJ_DIR)/lvs-input.json $(OBJ_DIR)/par-rundir/$(TOP).gds
+	mkdir -p $(dir $@)
+	$(HAMMER_EXEC) -e $(ENV_YML) -p $< --obj_dir $(OBJ_DIR) lvs
+
+.PHONY: clean
+clean:
+	rm -rf $(OBJ_DIR) hammer-vlsi*.log __pycache__ output.json $(GENERATED_CONFS) generated-src
diff --git a/vlsi/README.md b/vlsi/README.md
new file mode 100644
index 0000000..d09fb5d
--- /dev/null
+++ b/vlsi/README.md
@@ -0,0 +1,5 @@
+This is the starting point for a vlsi flow from this repository.
+
+This flow will not work without the necessary CAD and technology plugins for HAMMER.
+
+If you are a UCB-affiliate, you may be able to acquire access to the tech-plugins.
\ No newline at end of file
diff --git a/vlsi/example-vlsi b/vlsi/example-vlsi
new file mode 100755
index 0000000..90ddec3
--- /dev/null
+++ b/vlsi/example-vlsi
@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+
+import hammer_vlsi
+from hammer_vlsi import CLIDriver
+
+from typing import Dict, Callable, Optional
+
+def example_place_tap_cells(x: hammer_vlsi.HammerTool) -> bool:
+    x.append('''
+# TODO
+''')
+    return True
+
+class ExampleDriver(CLIDriver):
+
+    def action_map(self) -> Dict[str, Callable[[hammer_vlsi.HammerDriver, Callable[[str], None]], Optional[dict]]]:
+        par_action = self.create_par_action(custom_hooks=[
+            hammer_vlsi.HammerTool.make_replacement_hook("place_tap_cells", example_place_tap_cells)
+        ])
+
+        new_dict = dict(super().action_map())
+        new_dict.update({
+            "par": par_action
+        })
+        return new_dict
+
+    def par_action(self, driver: hammer_vlsi.HammerDriver, append_error_func: Callable[[str], None]) -> Optional[dict]:
+        if not driver.load_par_tool():
+            return None
+        success, par_output = driver.run_par(hook_actions=[
+            hammer_vlsi.HammerTool.make_replacement_hook("place_tap_cells", example_place_tap_cells)
+            ])
+        return par_output
+
+if __name__ == '__main__':
+    ExampleDriver().main()
diff --git a/vlsi/hammer b/vlsi/hammer
new file mode 160000
index 0000000..873b2c1
--- /dev/null
+++ b/vlsi/hammer
@@ -0,0 +1 @@
+Subproject commit 873b2c1af0a54cb339a19a7c8cf3a1e7905feb58